Submit user KYC

[POST] /api/v2/user/kyc

Submits KYC documents for a user.

Request body type:

type RequestBody = {
  userEmail: string;
  documentId: string;
  userFields: Record<string, any>;
}

Request body example (basic KYC):

{
    "userEmail": "[email protected]",
    "documentId": "67da909b739fc481aa525c43",
    "userFields": {
        "first_name": "John",
        "last_name": "Doe",
        "dob": "1990-01-01",
        "id_number": "A123456789"
    }
}

For advanced kyc, an array of images must be provided. Each image object should contain an "image_type_id" field where with one of these values:

• 0 - the type of an image is "selfie"

• 1 - the type of an image is "front side of the document"

• 2 - the type of an image is "back side of the document".

The "image" field should contain either a public URL to an image or a base64 string of an encoded image.

Request body example (advanced KYC):

{
  "userEmail": "[email protected]",
  "countryIsoCode": "NG",
  "documentId": "67da93c0dfd3a00f3380b857",
  "userFields": {
    "first_name": "John",
    "last_name": "Doe",
    "dob": "1990-01-01",
    "images": [
      { "image_type_id": 0, "image": "https://cdn.com/selfie.jpg" },
      { "image_type_id": 1, "image": "https://cdn.com/front.jpg" },
      { "image_type_id": 5, "image": "https://cdn.com/back.jpg" }
    ]
  }
}

Response is the same as ge