Status
Request URL
POST /akepa/status
Description
This endpoint will return the details of the KYC/KYB process for the requested customer. The status for a specified customer KYC application can be checked at any point after identification initialization.
If you included a webhook URL in the /akepa/identification request, then you will automatically receive a callback at your webhook endpoint if the application status changes to "completed" asynchronously. This may happen if your /akepa/update request moved the application status into a "waiting_review" status instead of "completed". When the application with status "waiting_review" is reviewed and completed manually, this triggers the webhook callback.
Schema
Property table for akepa/status
| Property | Description | Required | Schema |
|---|---|---|---|
| customerId | Customer ID in connectFi | Yes | { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "description": "common-id" } |
| applicationId | The application ID in connectFi | Yes | { "type": "string", "pattern": "^[0-9a-zA-Z_]+$", "minLength": 1, "maxLength": 36, "description": "common-id" } |
Request Body
Snippet Examples
javascript
const axios = require('axios');
const data = {
"customerId" : "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"applicationId": "iapp_1BGgJeDQJFo5MCup15zq9A"
};
const config = {
method: 'POST',
url: '${CONNECTFI_BASE_URL}/akepa/status',
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/status" --data "{\"customerId\": \"cstap_5mBHiIx3QbkvEpjGfKsI9k\", \"applicationId\":\"iapp_1BGgJeDQJFo5MCup15zq9A\"}" --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/STATUS 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
RESPONSE BODY
{
"code": "0",
"data": {
"applicationId": "iapp_1BGgJeDQJFo5MCup15zq9A",
"aggregatorId": "CLIENTID",
"customerId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"reference": "extRefApp101",
"status": "pending_step_up",
"outcome": null,
"entityApplications": [
{
"entityId": "cstap_5mBHiIx3QbkvEpjGfKsI9k",
"isCustomer": true,
"status": "pending_step_up",
"outcome": null
}
]
},
"requestId": "45530240b9f811eeb6a5bb65dd1aad12"
}
200 AKEPA/STATUS 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
RESPONSE BODY
{
"code": "0",
"data": {
"applicationId": "iapp_3akMumble7qYVIe8rmjq14",
"aggregatorId": "CLIENTID",
"customerId": "cstab_2rw49JIoVAl3PCsaXdNoSS",
"reference": "extRefBApp101",
"status": "pending_step_up",
"outcome": null,
"entityApplications": [
{
"entityId": "cstab_2rw49LnrnSuy9206ylJ2bU",
"isCustomer": false,
"status": "pending_step_up",
"outcome": null
},
{
"entityId": "cstab_2rw49JIoVAl3PCsaXdNoSS",
"isCustomer": true,
"status": "completed",
"outcome": "approved"
}
]
},
"requestId": "70c889d0b9f911eeb6a5bb65dd1aad12"
}