The Entity
resource represents a user or other identity that needs verification. A Service
contains Entities
and an Entity
contains Factors
.
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.
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.
The date that this Entity was created, given in ISO 8601 format.
The date that this Entity was updated, given in ISO 8601 format.
Contains a dictionary of URL links to nested resources of this Entity.
POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
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.
GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{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.
GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
How many resources to return in each list page. The default is 50, and the maximum is 1000.
DELETE https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{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.