The identities endpoint is used to retrieve the underlying identity (PII) of an Entity. The Identity endpoint requires an Entity to have at least a name and phone number.
For an active entity or entities with a matched identity (verification.identity.matched
) the identity endpoint will return a single identity with the PII.
For all other entities the identity endpoint could return multiple identities as the provided PII was not enough to
disambiguate and match a single identity.
The Identity endpoint is restricted to most teams. Contact your Method CSM for more information.
The Identity endpoint is available as a:
Type Use-Case Product
Retrieve the full Identity (PII) for any Entity
Identity Objects
Unique identifier for the Identity.
The ID of the associated Entity.
Status of the Identity.
pending
The Identity is queued to be retrieved.
in_progress
The Identity is being retrieved.
completed
The Identity has successfully been retrieved.
failed
The Identity failed to be retrieved.
An array of identity objects.
The legal first name of the identity.
The legal last name of the identity.
The identity's date of birth in ISO 8601 format.
Mobile phone number of the identity in E.164 format. The number will only be used for KYC / AML verification.
The identity's address.
identities.address.address
The number and street of the identity's address.
The city of the identity's address.
identities.address.postal_code
The postal code of the identity's address.
The two-letter abbreviation for the state of the identity's address.
An object representing an error that occurred while processing this Identity. See Identity errors .
Timestamp of when the Identity was created.
Timestamp of when the Identity was last updated.
{
"id" : "idn_NhTRUVEknYaFM" ,
"entity_id" : "ent_au22b1fbFJbp8" ,
"status" : "completed" ,
"identities" : [
{
"first_name" : "KEVIN" ,
"last_name" : "DOYLE" ,
"dob" : "1997-03-18" ,
"ssn" : "111223333" ,
"phone" : "+16505551115" ,
"address" : {
"address" : "3300 N INTERSTATE 35" ,
"city" : "AUSTIN" ,
"postal_code" : "78705" ,
"state" : "TX"
}
},
{
"first_name" : "JOE" ,
"last_name" : "DOYLE" ,
"dob" : "1997-03-18" ,
"ssn" : "123456789" ,
"phone" : "+16505551115" ,
"address" : {
"address" : "3300 N INTERSTATE 35" ,
"city" : "AUSTIN" ,
"postal_code" : "78705" ,
"state" : "TX"
}
}
],
"error" : null ,
"created_at" : "2024-01-16T19:36:08.263Z" ,
"updated_at" : "2024-01-16T19:36:08.263Z"
}