Skip to content
/
Identity Retrieval

Identity Retrieval

Request

Enables retrieval of detailed information about a specific identity using the unique identityReference.

Security
HMACAuth
Path
identity_referencestring, <= 100 charactersrequired

The identity reference to retrieve data for.

Example:/identities/c-13344
Query
emailstring, (email), <= 254 characters

Optional email address to assist with identity matching.

Example:[email protected]
curl -i -X GET \
  'https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/identities//identities/c-13344?email=user%40example.com' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful identity response

Bodyapplication/json
identityReferencestring, [ 1 .. 255 ] characters(Identity Reference)^[A-Za-z0-9-]+$required

A unique customer identifier provided by the partner. This field is required and must be unique for each customer.

Important: You must consistently reuse the same identityReference for repeat interactions with the same customer, allowing Banxa to reliably recognize and associate their identity across multiple transactions.

Format Requirements:

  • Only ASCII letters (a-z, A-Z), digits (0-9), and hyphens (-) are allowed
  • Must be between 1 and 255 characters
  • Case-sensitive

Best Practices:

  • Use a consistent format across your system
  • Consider using a prefix to identify your organization (e.g., 'partner-customer-123')
  • Do not include personally identifiable information (PII) in the reference
  • Store the mapping between your internal customer ID and this reference securely
Example:"c-13344"
accountobjectrequired
kycobjectrequired

Reflects the verification status of identity documents submitted through Banxa's identity provider. This status is updated based on document and liveness verification only — it does not account for Lite tier data, supplementary fields (e.g. purpose of transaction, occupation), or overall transaction eligibility. Use the eligibility endpoint to determine whether a customer can transact.

Response
Identity exists with verified KYC data on file. Note: VERIFIED status means the identity data we have is validated, but does not guarantee transaction eligibility. Check the eligibility endpoint before allowing transactions.
{
  "identityReference": "customer-12345",
  "account": {
    "blocked": false,
    "exists": true,
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "kyc": {
    "status": "VERIFIED"
  }
}
© Banxa 2026