Identities Service (KYC Sharing)

Overview

We offer an enhanced KYC service through our Identity API where you can send your customer's KYC information to Banxa before they create an order. This removes the need for customers to re-submit personal details and upload KYC documentation again during the Banxa checkout flow.

Please note that you should only send through customer details of already KYC verified customers, and ideally at the point of verification. You may also choose to use this API as part of your partner onboarding process, where you can transfer all your customer's details by calling the endpoint in sequence.

Additionally, there may still be a need for customers to submit additional details where the information is needed in order to fulfil Banxa regulatory requirements. This endpoint allows the sharing of customer KYC information to reduce the need for customer to re-submit data, however Banxa is still required to conduct KYC due diligence.

10371037

Before you begin

  • Have an existing KYC process where you collect customer information
  • Completed the Banxa questionnaire to confirm solution fit
  • If using Sumsub, completed token sharing agreement

Customer awareness

When using Identities endpoint we recommend that customers are advised that their personal details and KYC documents will be shared with Banxa. This reduces customer confusion if Banxa is required to contact the Customer to collect additional documents.

Sumsub

If you use Sumsub as your KYC provider, you may customer's Sumsub KYC token through this endpoint. This will allow Banxa to verify and retrieve the customer's KYC data in order as well as ensure that the customer will not need to go through KYC again during the Banxa checkout flow. Implementation using Sumsub will reduce the amount of information and documentation that you need to pass through, as Banxa will be able retrieve all the required KYC details through the Sumsub API.

You can find Sumsub documentation for KYC sharing here.

Required parameters for Sumsub

Please review the API Reference document for details of the required request structure.

Parameter

Description

Format

account_reference

Unique customer reference provided by you.

string

mobile_number

Customer's mobile number. Not required if account_reference is passed through.

string

email

Customer's email. Not required if account_reference is passed through.

string

given_name

Customer given name.

string

surname

Customer surname.

string

country

Customer's residential country.

string

provider

This field is the name of your KYC provider, and in this case should always have the value of sumsub passed through.

string

token

Unique Sumsub customer ID that Banxa will use to retrieve customer KYC details.

string

Example request

curl -X POST "https://[PARTNER-NAME].banxa.com/api/identities" \
  -H "Authorization: Bearer xxxxxxxx:xxxx-xxxx-xxxx:xxxxxxxx" \
  -H "Accept: application/json" \
  -d \
'{
    "account_reference": "test001001",
    "mobile_number": "61431000001",
    "email": "[email protected]",
    "customer_identity": {
        "given_name": "Joe",
        "surname": "Bloggs",
        "residential_address": {
            "country": "AU"
        }
    },
    "identity_sharing": [{
      "provider": "sumsub", 
      "token": "_act-57c9e30d-2768-406d-99a5-d9646ebfc9dd"
    }
    ]
}

👍

The identity_sharing object should contain an array of objects, with your provider and token parameters inside.

All other KYC providers

When using this endpoint to transfer customer information and documents, most parameters are optional, however we recommend that you pass as much data as is available. This improves conversion significantly.

Documents can be sent using an image link that points to where the image is store e.g. https://www.orimi.com/pdf-test.pdf. When sending us identity documents, at least one or several image links can be sent. We currently accept JPEG, JPG, and PNG as acceptable file formats. The minimum file size is 32KB and the maximum file size is 10MB. For the image link, we require that all image links to come from a secure https:// URL request. The image link should preferably be a one time link to download the document. This ensures it will not be downloaded by other parties.

Required parameters

Please review the API Reference document for details of the required request structure.

Parameter

Description

Type

account_reference

Unique customer reference provided by you.

string

mobile_number

Customer's mobile number. Not required if account_reference is passed through.

string

email

Customer's email. Not required if account_reference is passed through.

string

given_name

Customer given name.

string

surname

Customer's surname.

string

country

Customer's residential country.

string

Example request

curl -X POST "https://[PARTNER-NAME].banxa.com/api/identities" \
  -H "Authorization: Bearer xxxxxxxx:xxxx-xxxx-xxxx:xxxxxxxx" \
  -H "Accept: application/json" \
  -d \
'{
  "account_reference": "test001001",
  "mobile_number": "61431000001",
  "email": "[email protected]",
  "customer_identity": {
    "given_name": "Joe",
    "surname": "Bloggs",
    "dob": "1990-01-31",
    "residential_address": {
      "address_line_1": "44 Gwynne Street",
      "suburb": "Cremorne",
      "post_code": "3121",
      "state": "VIC",
      "country": "AU"
    }
  },
  "identity_documents": [
    {
      "type": "PASSPORT",
      "data": {
        "number": "123456789"
      },
      "images": [
        {
          "link": "https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png"
        },
        {
          "link": "https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png"
        },
        {
          "link": "https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png"
        }
      ]
    }
  ]
}'