Generate the Links needs to complete KYC for an individual or business

POST

/kyc_links

Generate the Links needs to complete KYC for an individual or business.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

KYC Links generated

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://online-banking.originalaccounts.com/kyc_links' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "full_name": "string",
    "email": "string",
    "type": "individual",
    "endorsements": [
        "string"
    ],
    "redirect_uri": "string"
}'

Response Example

200 - Example 1

{
    "id": "string",
    "type": "individual",
    "customer_id": "string",
    "full_name": "string",
    "email": "string",
    "kyc_link": "string",
    "kyc_status": "string",
    "rejection_reasons": [
        {
            "developer_reason": "string",
            "reason": "string",
            "created_at": "string"
        }
    ],
    "tos_link": "string",
    "tos_status": "string",
    "created_at": "2019-08-24T14:15:22.123Z"
}

Modified at 2025-12-19 15:30:02

Create a Batch Settlement Schedule

Get all KYC links