Menu

Expand
Rate this page:

Entity Resource

Verify Push is in Public Beta.

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
sid<YE> Not PII

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
sid<AC> Not PII

The unique SID identifier of the Account.

service_sid
sid<VA> Not PII

The unique SID identifier of the Service.

date_created
date_time<iso8601> Not PII

The date that this Entity was created, given in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date that this Entity was updated, given in ISO 8601 format.

url
url Not PII

The URL of this resource.

links
uri_map Not PII

Contains a dictionary of URL links to nested resources of this Entity.

Create an Entity resource

post
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
Parameters
Parameters in REST API format
service_sid
Path
post sid<VA> Not PII

The unique SID identifier of the Service.

identity
Required
post string PII MTL: 30 DAYS

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

        get
        https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<VA> Not PII

        The unique SID identifier of the Service.

        identity
        Path
        get string PII MTL: 30 DAYS

        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

              get
              https://verify.twilio.com/v2/Services/{ServiceSid}/Entities
              Parameters
              Parameters in REST API format
              service_sid
              Path
              get sid<VA> Not PII

              The unique SID identifier of the Service.

              Example 1
                    
                    
                    

                    Delete an Entity resource

                    delete
                    https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    delete sid<VA> Not PII

                    The unique SID identifier of the Service.

                    identity
                    Path
                    delete string PII MTL: 30 DAYS

                    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
                          
                          
                          
                          Rate this page:

                          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 Community Forums or browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more