Patching KYC data

The following API endpoints provide an ability to correct user data, submitted for KYC. When all the changes are done, the verification should be initiated again.

The API endpoints should be used when the status of the KYC check is SOFT_KYC_FAILED. It means, that the submitted data contains some minor issues, like incorrect date of birth or unreadable proof of identity.

There are two API endpoints provided:

  1. One for correcting documents.

    1. Re-use the upload API. It'll rewrite the documents for verification.

  2. One for correcting account and applicant data (date of birth, email, T&C etc.).

    1. Use the API below.

Before using the API make sure that the customer has approved Terms and Condition.

Updates customer bank transfer profile details. Only the provided fields will be updated.

patch

Updates the bank transfer profile details for a specified customer. This endpoint allows for partial updates; thus, only the fields provided in the request body will be updated.

Access to this endpoint requires a valid API key. The API key is sent in the x-api-key header on requests.

Authorizations
Path parameters
idstringRequired
  • The external identifier for the customer, used to uniquely identify them and associate them with a merchant.
Body
  • The details to be updated. This includes optional fields for the customer's first name, last name, date of birth, email, target address, and physical address. Params:
  • address.city - The city name.
  • address.postCode - The postcode.
  • address.addressLine1 - The address line 1.
  • address.addressLine2 - The address line 2.
  • address.country - The ISO 3166-1 alpha-2 country name.
  • dateOfBirth - Date of Birth. "YYYY-MM-DD".
  • lastName - The last name.
  • firstName - The first name.
  • email - The email address.
  • acceptedPrivacyPolicyHash - base64-encoded SHA256 hash of the Privacy Policy. Required for API-driven KYC flows.
  • acceptedTermsAndConditionsHash - Optional base64-encoded SHA256 hash of Terms & Conditions. Required for API-driven KYC flows.
  • acceptedTermsOfServiceHash - Optional base64-encoded SHA256 hash of Terms of Service. Required for API-driven KYC flows.
acceptedTermsOfServiceHashstringOptional
acceptedTermsAndConditionsHashstringOptional
acceptedPrivacyPolicyHashstringOptional
lastNamestringOptional
firstNamestringOptional
emailstringOptional
dateOfBirthstring · date-timeOptional
addressanyOptional
Responses
204

Action has been accepted

application/json
patch
PATCH /api/v2/customer/{id}/bank-transfer HTTP/1.1
Host: api.xgateway.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "address": {
    "city": "Sydney",
    "postCode": "2000",
    "addressLine1": "45 Pitt Street",
    "addressLine2": "Level 2, Suite 3",
    "country": "AU"
  },
  "dateOfBirth": "1990-12-25",
  "lastName": "Doe",
  "firstName": "John",
  "email": "[email protected]"
}
{
  "data": "Action has been accepted",
  "success": true
}

Last updated