KYC

Get Cardholder KYC

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

Endpoint

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

Description

Retrieves the KYC details for a cardholder within the system. This API allows the cardholder to view their submitted verification information, helping ensure compliance and maintain accurate records.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholderHash-id	string	Yes	Cardholder Identification
x-client-id	string	Yes	Client Identification
x-client-name	string	Yes	Client Identification Name
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

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-client-name: {{ClientName}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

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

{
  "message": "Get KYC Details failed!",
  "status": "BAD_REQUEST"
}

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.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholderHash-id	string	Yes	Cardholder Identification
x-client-id	string	Yes	Client Identification
x-client-name	string	Yes	Client Identification Name
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

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-client-name: {{ClientName}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

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

{
  "message": "Get RFI details failed!",
  "status": "BAD_REQUEST"
}

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 enables clients to submit responses or additional details requested during a cardholder’s KYC verification process. It helps ensure timely resolution of RFI cases and maintains compliance with verification requirements.

Request Path Parameters

Parameter	Type	Required	Description
version	string	Yes	API version number

Request Headers

Parameter	Type	Required	Description
x-api-key	string	Yes	Shared X-API key
x-product-id	string	Yes	Shared ProductID
x-cardholderHash-id	string	Yes	Cardholder Identification
x-client-id	string	Yes	Client Identification
x-client-name	string	Yes	Client Identification Name
x-request-id	string	Yes	Idempotency key for request tracking
Content-Type	string	Yes	Must be application/json

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-client-name: {{ClientName}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'Content-Type: application/json' \

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

{
  "message": "Respond to RFI Api failed!",
  "status": "BAD_REQUEST"
}