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.
sid
type: SID<YE>A 34 character string that uniquely identifies this Entity.
^YE[0-9a-fA-F]{32}$
34
34
identity
type: stringThe 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
type: SID<AC>The unique SID identifier of the Account.
^AC[0-9a-fA-F]{32}$
34
34
service_sid
type: SID<VA>The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$
34
34
links
type: object<uri-map>Contains a dictionary of URL links to nested resources of this Entity.
POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
ServiceSid
type: SID<VA>The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$
34
34
Identity
type: stringRequiredThe 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}
ServiceSid
type: SID<VA>The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$
34
34
Identity
type: stringThe 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
ServiceSid
type: SID<VA>The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$
34
34
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
DELETE https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}
ServiceSid
type: SID<VA>The unique SID identifier of the Service.
^VA[0-9a-fA-F]{32}$
34
34
Identity
type: stringThe 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.