# Identity Reliance

Share customer identity

Endpoint: POST /eapi/v0/identities/reliance
Version: 0 BETA
Security: HMACAuth

## Request fields (application/json):

  - `identityReference` (string, required)
    ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.
    Example: "c-13344"

  - `mobileNumber` (string, required)
    Mobile number of the customer.
    Example: "61431000001"

  - `email` (string, required)
    Email address of the customer.
    Example: "test@bitcoin.com.au"

  - `screeningDate` (string, required)
    The UTC screening date of the applicant.
    Example: "2023-06-05"

  - `screeningSanctionsResult` (boolean, required)
    The result of the sanction screening.
    Example: true

  - `screeningPepResult` (boolean, required)
    The result of the PEP sanction screening.
    Example: true

  - `customerIdentity` (object, required)

  - `customerIdentity.givenName` (string, required)
    Customer's given / first name.
    Example: "Joe"

  - `customerIdentity.surname` (string, required)
    Customer's surname / last name.
    Example: "Bloggs"

  - `customerIdentity.dob` (string, required)
    Customer's date of birth (e.g. "1985-01-31"). Required to format as ISO 8601 Date format : YYYY-MM-DD.
    Example: "1990-01-31"

  - `customerIdentity.taxIdType` (string)
    Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US.  Must be a nine-digit number in the format "AAA-GG-SSSS".
    Example: "ssn"

  - `customerIdentity.taxId` (string)
    Tax identification number (e.g. SSN). Optional unless required (e.g. for US). This is the national identifier for the customer, for example, the customer's Social Security number (SSN) in the US.  Must be a nine-digit number in the format "AAA-GG-SSSS".
    Example: "123-11-123"

  - `customerIdentity.taxState` (string)
    Tax state or region if applicable.(associated with the taxId) Required format as two characters. Note; We do not accept any states where Banxa is not licensed.
    Example: "IL"

  - `customerIdentity.residentialAddress` (object, required)

  - `customerIdentity.residentialAddress.addressLine` (string, required)
    Street address.
    Example: "44 Gwynne Street"

  - `customerIdentity.residentialAddress.suburb` (string, required)
    Suburb of the address.
    Example: "Cremorne"

  - `customerIdentity.residentialAddress.state` (string, required)
    State or region, required when country is US.
    Example: "VIC"

  - `customerIdentity.residentialAddress.postCode` (string, required)
    Postal code.
    Example: "3121"

  - `customerIdentity.residentialAddress.country` (string, required)
    Country code.
    Example: "AU"

  - `identityDocuments` (array, required)
    Collection of identity documents colected frofmo the customer. (array of objects)

  - `identityDocuments.type` (string)
    The type of document collected from the applicant.
    Enum: "DRIVING_LICENSE", "PASSPORT", "IDENTIFICATION"

  - `identityDocuments.data` (object)
    The document data collected from the customer.

  - `identityDocuments.data.number` (string)
    Identifier number from the document.
    Example: "123456789"

## Response 202 fields (application/json):

  - `identityReference` (string, required)
    ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.
    Example: "c-13344"

## Response 400 fields (application/json):

  - `message` (string)
    Example: "Bad Request"

  - `status` (integer)
    Example: 400

  - `traceId` (string)
    Idempotency key for the error
    Example: "2b6fc5d0-57e4-4b5a-9e3c-6cfbb6d8023f"

## Response 401 fields (application/json):

  - `message` (string)
    Example: "Unauthenticated."

  - `status` (integer)
    Example: 401

## Response 404 fields (application/json):

  - `message` (string)
    Example: "Not Found"

  - `status` (integer)
    Example: 404

## Response 422 fields (application/json):

  - `message` (string)
    Example: "The given data was invalid."

  - `errors` (object)

  - `status` (integer)
    Example: 422

## Response 500 fields (application/json):

  - `message` (string)
    Example: "Server Error"

  - `status` (integer)
    Example: 500

  - `traceId` (string)
    Idempotency key for the error
    Example: "2b6fc5d0-57e4-4b5a-9e3c-6cfbb6d8023f"