The identities endpoint
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 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.
An array of identity objects.
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.