Identification

Request URL

POST /akepa/identification

Description

This endpoint starts the KYC/KYB (Know Your Customer/Business) process. A customer may or may not pass KYC/KYB right away. In response to this request, the system will indicate if additional data or document images are required. If the application completes asynchronously, expect a callback at your webhookURL endpoint.

Schema

Property table for akepa/identification

Property	Description	Required	Schema
reference	An external alphanumeric reference ID for the entity in your system	Yes	{   "type": "string",   "pattern": "^[0-9a-zA-Z]+$",   "minLength": 1,   "maxLength": 32,   "description": "common-reference" }
customerId	Customer ID in connectFi	Yes	{   "type": "string",   "pattern": "^[0-9a-zA-Z_]+$",   "minLength": 1,   "maxLength": 36,   "description": "common-id" }
syncMode	true if asyncronous	No	{   "type": "boolean",   "nullable": true }
webhookURL	If you specify a webhookURL in this request, the system will perform a callback to your webhookURL to notify you of specified asynchronous status changes.	No	{   "type": "string",   "pattern": "^((?![<>]).)*$",   "minLength": 0,   "maxLength": 500,   "nullable": true,   "description": "common-commonStr500" }

Request Body

{
    "customerId" : "cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "reference": "UNIQUE_REFERENCE_ID",
    "webhookUrl": "https://your_webhook_url/UNIQUE_REFERENCE_ID"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "customerId" : "cstap_5mBHiIx3QbkvEpjGfKsI9k",
    "reference": "UNIQUE_REFERENCE_ID",
    "webhookUrl": "https://your_webhook_url/UNIQUE_REFERENCE_ID"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/akepa/identification',
  headers: {
    'Content-Type': "application/json",
    'x-connectfi-token': "A long random string token received from /auth/get-token request"
  },
  data
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "CONNECTFI_BASE_URL/akepa/identification" --data "{\"customerId\": \"cstap_5mBHiIx3QbkvEpjGfKsI9k\",   \"reference\":\"UNIQUE_REFERENCE_ID\",   \"webhookUrl\":\"https://your_webhook_url/UNIQUE_REFERENCE_ID\"}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request" 

Successful Response Examples

200 AKEPA/IDENTIFICATION SUCCESSFUL RESPONSE FOR INDIVIDUAL CUSTOMER

HEADERS

Header	Value
Content-Type	application/json
x-connectfi-token	A long random string token received from /auth/get-token request

REQUEST BODY

{
    "customerId" : "cstap_6reGTr3k8vpAu8uFV7EdiN",
    "reference": "extRefApp100",
    "webhookUrl": "https://your_webhook_url/extRefApp100"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "applicationId": "iapp_AwXROkAVhfKmkhXjOTmuK",
        "aggregatorId": "CLIENTID",
        "customerId": "cstap_6reGTr3k8vpAu8uFV7EdiN",
        "reference": "extRefApp100",
        "status": "pending_step_up",
        "outcome": null,
        "entityApplications": [
            {
                "entityId": "cstap_6reGTr3k8vpAu8uFV7EdiN",
                "isCustomer": true,
                "status": "pending_step_up",
                "outcome": null
            }
        ]
    },
    "requestId": "135520d078d411eeb5658f28ab5fe311"
}

200 AKEPA/IDENTIFICATION SUCCESSFUL RESPONSE FOR BUSINESS CUSTOMER

HEADERS

Header	Value
Content-Type	application/json
x-connectfi-token	A long random string token received from /auth/get-token request

REQUEST BODY

{
    "customerId" : "cstab_7BX5DO49J48VeWKsJ6gWNb",
    "reference": "extRefBApp100",
    "webhookUrl": "https://your_webhook_url/extRefBApp100"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "applicationId": "iapp_3TjDAthM8ZoyKRQOJBUOZk",
        "aggregatorId": "CLIENTID",
        "customerId": "cstab_7BX5DO49J48VeWKsJ6gWNb",
        "reference": "extRefBApp100",
        "status": "pending_step_up",
        "outcome": null,
        "entityApplications": [
            {
                "entityId": "cstab_7BX5DPJcbmipymiokecA6d",
                "isCustomer": false,
                "status": "pending_step_up",
                "outcome": null
            },
            {
                "entityId": "cstab_7BX5DO49J48VeWKsJ6gWNb",
                "isCustomer": true,
                "status": "completed",
                "outcome": "approved"
            }
        ]
    },
    "requestId": "7fe10b9078db11eeb5658f28ab5fe311"
}