Skip to content
/
Identity Reliance

Identity Reliance

Request

Share customer identity

Security
HMACAuth
Bodyapplication/jsonrequired
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"
mobileNumberstringrequired

Mobile number of the customer.

Example:"61431000001"
emailstring, (email)required

Email address of the customer.

Example:"[email protected]"
screeningDatestring, (date)required

The UTC screening date of the applicant.

Example:"2023-06-05"
screeningSanctionsResultbooleanrequired

The result of the sanction screening.

Example:true
screeningPepResultbooleanrequired

The result of the PEP sanction screening.

Example:true
customerIdentityobject(CustomerIdentity)required
identityDocumentsArray of objects(IdentityRelianceDocument)required

Collection of identity documents colected frofmo the customer. (array of objects)

curl -i -X POST \
  https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/identities/reliance \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "customer-12345",
    "email": "[email protected]",
    "mobileNumber": "+61431000001",
    "screeningDate": "2024-01-15",
    "screeningSanctionsResult": true,
    "screeningPepResult": true,
    "customerIdentity": {
      "givenName": "John",
      "surname": "Doe",
      "dob": "1990-01-15",
      "residentialAddress": {
        "addressLine": "123 Main Street",
        "suburb": "Sydney",
        "state": "NSW",
        "postCode": "2000",
        "country": "AU"
      }
    },
    "identityDocuments": [
      {
        "type": "PASSPORT",
        "data": {
          "number": "N1234567"
        }
      }
    ]
  }'

Responses

The identity sharing request has been accepted for processing

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"
Response
{
  "identityReference": "customer-12345"
}
© Banxa 2026