Entity Resource
The Entity resource represents a user or other identity that needs verification. A Service contains Entities and an Entity contains Factors.
Entity properties
Do not use Personally Identifiable Information for identity. Use an immutable user identifier like a system UUID, GUID, or SID.
Verify Push uses identity as a unique identifier of a user. You should not use directly identifying information (aka personally identifiable information or PII) like a person's name, home address, email or phone number, etc., as identity because the systems that will process this attribute assume it is not directly identifying information.
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this Entity. |
identity
|
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. |
account_sid
|
The unique SID identifier of the Account. |
service_sid
|
The unique SID identifier of the Service. |
date_created
|
The date that this Entity was created, given in ISO 8601 format. |
date_updated
|
The date that this Entity was updated, given in ISO 8601 format. |
url
|
The URL of this resource. |
links
|
Contains a dictionary of URL links to nested resources of this Entity. |
Create an Entity resource
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Required
|
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. |
Example 1
Fetch an Entity resource
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. |
Example 1
Read multiple Entity resources
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
Example 1
Delete an Entity resource
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The unique SID identifier of the Service. |
identity
Path
|
The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
