Contact Get Identity
GET {{URL}}/v1/contacts/{{Recipient-WA-ID}}/identity
It is possible to receive notifications from WhatsApp when a user you are communicating with has potentially changed. Use this /v1/contacts edge to manage users' identities. See Understanding Identity Change for WhatsApp Business for more information.
For more information about the system notification sent from WhatsApp see Inbound System Messages — Example: A User Potentially Changed . The response to the system notification is managed by your business.
A
GET
call to the
/v1/contacts/{{users-whatsapp-id}}/identity
endpoint retrieves the latest identity hash for a user.
Returned Fields
| Name | Description |
|---|---|
acknowledged
Type: String |
The state of acknowledgment for the latest
user_identity_changed
system notification.
|
created_timestamp
Type: Integer | The timestamp from when the WhatsApp Business API client detected the user potentially changed. |
hash
Type: String |
Identifier for the latest
user_identity_changed system
notification.
|
Response
If successful, your request returns
200 OK
and a message body containing a contacts object.
HEADERS
| Key | Datatype | Required | Description |
| Authorization | string | | |
RESPONSES
status: OK
{"contacts":{"hash":"UKD6Y/5SqDU=","created_timestamp":1600132094000,"acknowledged":true},"meta":{"api_status":"stable","version":"v2.45.1"}}