KYC

Get Cardholder KYC

This API checks a cardholder's KYC status and lets them complete verification.

Endpoint

GET {{baseUrl}}/issuing/api/:version/kyc

Description

This API retrieves the current KYC status for a cardholder and allows them to check on and complete their KYC verification. If KYC is still pending, the response includes a document submission link, the cardholder can use to perform KYC.

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholderHash-id string required

Unique identifier of the cardholder

x-client-id string required

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/kyc' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholderHash-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/kyc"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholderHash-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/kyc")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholderHash-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/kyc',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholderHash-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "success",
  "message": "Fetching KYC details successfully!",
  "code": 200,
  "data": [
    {
      "kycStatus": "COMPLETED",
      "kycLink": "",
      "documentType": "E_KYC",
      "complianceStatus": "COMPLETED",
      "email": ""
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

📋 Get Cardholder KYC — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholderHash-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Get RFI Details

This API allows you to retrieves the RFI details for a cardholder in the system.

Endpoint

GET {{baseUrl}}/issuing/api/:version/kyc/rfi

Description

Retrieves the RFI (Request for Information) details for a cardholder within the system. This API allows the cardholder to view all requested and submitted information, helping monitor compliance and maintain accurate records.

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholderHash-id string required

Unique identifier of the cardholder

x-client-id string required

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/kyc/rfi' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholderHash-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/kyc/rfi"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholderHash-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/kyc/rfi")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholderHash-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/kyc/rfi',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholderHash-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "success",
  "message": "Fetching KYC details successfully!",
  "code": 200,
  "data": [
    {
      "services_declined_codes": {
        "address": [
          "SPDR31",
          "SPDR27",
          "SPDR24",
          "SPDR75",
          "SPDR23",
          "SPDR30"
        ],
        "document": [
          "SPDR14"
        ]
      },
      "declined_reason": "Issue date on the address document doesn't match"
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

📥 Get RFI Details — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholderHash-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯

Respond to RFI

This API is used to respond to an RFI (Request for Information) raised for a specific cardholder.

Endpoint

GET {{baseUrl}}/issuing/api/:version/kyc/rfi/respond

Description

This API returns a link for the cardholder to submit documents or additional details in response to an RFI (Request for Information) raised during KYC verification. It helps ensure timely resolution of RFI cases and maintains compliance with verification requirements.

🔗 Path Parameters

version string required

API version number. Default value is v1.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-cardholderHash-id string required

Unique identifier of the cardholder

x-client-id string required

Client identification key

x-request-id string required

Idempotency key for request tracking

Content-Type string required

Must be application/json

Authorization string

Bearer access token

🧩 Examples

Request Example

cURL

curl --location --request GET \
--url '{{baseUrl}}/issuing/api/:version/kyc/rfi/respond' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-cardholderHash-id: {{CardholderID}}' \
--header 'x-client-id: {{ClientID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}' \

Python

import requests
import json

url = "{{baseUrl}}/issuing/api/:version/kyc/rfi/respond"

payload = {}
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-cardholderHash-id': '{{CardholderID}}',
  'x-client-id': '{{ClientID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/issuing/api/:version/kyc/rfi/respond")
  .method("GET", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-cardholderHash-id", "{{CardholderID}}")
  .addHeader("x-client-id", "{{ClientID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

NodeJs

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/issuing/api/:version/kyc/rfi/respond',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-cardholderHash-id': '{{CardholderID}}', 
    'x-client-id': '{{ClientID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Response Example

200: Success

{
  "status": "success",
  "message": "Fetching KYC details successfully!",
  "code": 200,
  "data": [
    {
      "kycStatus": "PENDING",
      "kycLink": "kyc-link",
      "documentType": "E_KYC",
      "complianceStatus": "IN_PROGRESS",
      "email": ""
    }
  ]
}

400: Error

{
  "code": 400,
  "message": "Error Message",
  "status": "error"
}

🧪 Try It Out

📨 Respond To RFI — Sandbox

🔐 Headers

x-api-key:

x-product-id:

x-cardholderHash-id:

x-client-id:

x-request-id:

Authorization:

💻 Generated cURL Command

❯