Skip to content
Sub-Accounts Onboarding/
/
Upload Documents
Last updated

Upload Documents for KYC/KYB Verification

Overview

The documents verification process for Sub-Accounts with regards to KYC/KYB verification is a 2-step process, which includes:

  1. The File API to upload a documents and get back a File ID;
  2. The Account API to update the related Sub-Account with the File ID returned.

Upload Documents

To upload a verification document you can use the fileCreate endpoint by specifying VerificationDocument under the category field and the specific Sub-Account ID in the headers.

Be aware of the following constraints when uploading a verification document file:

  • Minimum Size: 10KB (binary)
  • Maximum Size: 4MB (binary)
  • Supported file extensions: pdf, jpeg, png

Example Request:

fileCreate - Payload Example
{
    "file": "@/path/image.png",
    "category": "VerificationDocument"
}

Make sure to include the Account header with the Sub-Account ID you are uploading the document for.

Example Response:

fileCreate - Response Example
{
    "id": "fl_XXXXXXXX",
    "name": "Screenshot (Passport) 2021-08-18_at_09.58.35.png",
    "type": "Png",
    "category": "VerificationDocument",
    "createdTimestamp": 1694718484,
    "lastUpdatedTimestamp": 1694718484,
    "sizeInBytes": 170282
}

Make sure you take note of the id value so you can use it for the next step.

Update Sub-Account with File ID

Once you have uploaded all required files and obtained their related file IDs, you can now update the Sub-Account entity with the IDs.

Example Request:

Send a request to our accountUpdateById endpoint.

accountUpdateById - Payload Example
{
    "individual": {
        "documents": [
            {
                "type": "NationalId",
                "front": "fl_XXXXXXXX",
                "back": "fl_YYYYYYYY",
                "country": "GB"
            }
        ]
    }
}

Next Steps

Once all required files have been uploaded by following the two steps above, the Sub-Account status will automatically change to Pending Verification. This indicates that the verification process has begun on Ryft’s side, and no further action is needed unless you receive an update.

If any document does not meet the required quality, type (e.g. a passport is provided instead of a driving licence) or validity, an email will be sent to the email address associated with the Sub-Account.

Main Account holders can also subscribe to our Accounts webhook to receive updates about their Sub-Accounts. See here.

Please Note: Sub-Accounts in the Pending Verification status cannot be updated. This restriction ensures we can fully verify the information and documents provided in line with the Sub-Account entity details.

In Sandbox environments, while the full flow of creating Sub-Accounts, providing information, and uploading documents can be tested, Sub-Accounts will not be verified automatically. They will remain in the Pending Verification status.

However, if needed, we can manually verify one or more Sub-Accounts upon request so that you can test the entire end-to-end workflow.

Previous page
Next page