Cardholder

A cardholder represents the person who will use a card. You must create a cardholder before issuing any card to them. Once a card is linked to a cardholder, the association cannot be changed.

Create Cardholder

This API allows you to create a new cardholder profile in the system.

{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder

Description

Cardholders are authorized representatives of your business and are associated with a named individual who represents your business. A cardholder can be associated with a card.
Creating a cardholder requires passing a name screening process, which involves submitting basic information about the cardholder.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

agent-code string required

Shared Agent Code

subagent-code string required

Shared Sub Agent Code

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

📦 Request Body

email string required

Email address of the cardholder.

mobile_number string required

Cardholder's mobile number without country code.

💡 See Phone Number Validation Rules for country-specific length requirements.

country_code string

2-letter ISO 3166-1 country code for the individual's mobile number. If not provided, it defaults to the individual's country.

individual object required

Details about the cardholder.

date_of_birth string required

Date of birth (ISO 8601 date format: YYYY-MM-DD). Cardholders must be at least 18 and under 80 years old.

name object required

Full name of the Individual. Only characters in English are supported.

first_name string required

First name of cardholder.

last_name string required

Last name of cardholder.

address object required

Physical address of cardholder.

city string required

City of address.

country string required

Country code (2-letter ISO 3166-1) of address.

line1 string required

Address line 1

line2 string

Address line 2

state string required

Address state

postcode string required

Address postal code

type string required

Type of cardholder. Allowed value: INDIVIDUAL

created_by string required

Creator identifier

🧩 Examples

Request Example

cURL
Python
Java
NodeJs

curl --location --request POST \
--url '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'agent-code: {{Shared Agent Code}}' \
--header 'subagent-code: {{Shared Sub-Agent Code}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'
--data-raw '{
  "email": "demo@yopmail.com",
  "mobile_number": "92271434",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
}'

import requests
import json

url = "{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder"

payload = json.dumps({
  "email": "demo@yopmail.com",
  "mobile_number": "92271434",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'agent-code': '{{Shared Agent Code}}',
  'subagent-code': '{{Shared Sub-Agent Code}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n      \"email\": \"demo@yopmail.com\",\r\n      \"mobile_number\": \"92271434\",\r\n      \"individual\": {\r\n        \"date_of_birth\": \"1990-01-01\",\r\n        \"name\": {\r\n          \"first_name\": \"John\",\r\n          \"last_name\": \"Doe\"\r\n        },\r\n        \"address\": {\r\n          \"city\": \"New York\",\r\n          \"country\": \"SG\",\r\n          \"line1\": \"123 5th Avenue\",\r\n          \"state\": \"NY\",\r\n          \"postcode\": \"10001\"\r\n        }\r\n      },\r\n      \"type\": \"INDIVIDUAL\",\r\n      \"created_by\": \"test\"\r\n    }");
Request request = new Request.Builder()
  .url("{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder")
  .method("POST", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("x-user-id", "{{UserID}}")
  .addHeader("agent-code", "{{Shared Agent Code}}")
  .addHeader("subagent-code", "{{Shared Sub-Agent Code}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');
let data = JSON.stringify({
  "email": "demo@yopmail.com",
  "mobile_number": "92271434",
  "individual": {
    "date_of_birth": "1990-01-01",
    "name": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "address": {
      "city": "New York",
      "country": "SG",
      "line1": "123 5th Avenue",
      "state": "NY",
      "postcode": "10001"
    }
  },
  "type": "INDIVIDUAL",
  "created_by": "test"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    'agent-code': '{{Shared Agent Code}}',
    'subagent-code': '{{Shared Sub-Agent Code}}'
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

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

Response Example

{
  "status": "success",
  "message": "Cardholder created successfully.",
  "code": 201,
  "data": [
    {
      "id": "cardholder-id"
    }
  ]
}

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

Get All Cardholders

{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder

Description

This API returns a list of all cardholders, allowing you to view and manage cardholder details easily.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

🔍 Query Parameters

status string

Cardholder status filter. Allowed values: PENDING, SUCCESS, INCOMPLETE, FAILED

page_num integer

Page number for pagination

page_size integer

Number of items per page

🧩 Examples

Request Example

cURL
Python
Java
NodeJs

curl --location --request GET \
--url '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

import requests
import json

url = "{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder"

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

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

print(response.json())

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

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder fetched successfully",
  "code": 200,
  "totalcount": 2,
  "data": [
    {
      "id": "cardholder-id",
      "email": "demo@yopmail.com",
      "country_code": "SG",
      "mobile_number": "92271434",
      "kyc_status": null,
      "status": "SUCCESS",
      "type": "INDIVIDUAL",
      "postal_address": {
        "line1": "123 5th Avenue",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "country": "SG",
        "postcode": "10001"
      },
      "individual": {
        "address": {
          "line1": "123 5th Avenue",
          "line2": null,
          "city": "New York",
          "state": "NY",
          "country": "SG",
          "postcode": "10001"
        },
        "date_of_birth": "1990-01-01",
        "employers": null,
        "name": {
          "title": null,
          "first_name": "John",
          "middle_name": null,
          "last_name": "Doe",
          "name_on_card": null
        }
      },
      "created_at": "2026-08-11 14:50:41",
      "review_status": "SUCCESS"
    },
    {
      "id": "cardholder-id",
      "email": "sandeep.test@yopmail.com",
      "country_code": "SG",
      "mobile_number": "92271430",
      "kyc_status": null,
      "status": "SUCCESS",
      "type": "INDIVIDUAL",
      "postal_address": {
        "line1": "5678 Oak Avenue",
        "line2": null,
        "city": "Los Angeles",
        "state": "CA",
        "country": "US",
        "postcode": "94932"
      },
      "individual": {
        "address": {
          "line1": "5678 Oak Avenue",
          "line2": null,
          "city": "Los Angeles",
          "state": "CA",
          "country": "US",
          "postcode": "94932"
        },
        "date_of_birth": "1998-08-11",
        "employers": null,
        "name": {
          "title": null,
          "first_name": "Sandeep",
          "middle_name": null,
          "last_name": "Sharma",
          "name_on_card": null
        }
      },
      "created_at": "2026-08-10 16:48:22",
      "review_status": "SUCCESS"
    }
  ]
}

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

Get Cardholder Details

This API is used to retrieve the cardholder details.

{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder

Description

This API is used to retrieve the details of a specific cardholder. You must provide the Cardholder ID or email ID as a query parameter to identify the cardholder.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

🔍 Query Parameters

id string

Unique identifier for cardholder

email string

Unique identifier for cardholder

🧩 Examples

Request Example

cURL
Python
Java
NodeJs

curl --location --request GET \
--url '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'

import requests
import json

url = "{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}"

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

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

print(response.text)

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

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    '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

{
  "status": "success",
  "message": "Cardholder fetched successfully",
  "code": 200,
  "data": [
    {
      "id": "cardholder-id",
      "email": "demo@yopmail.com",
      "country_code": "SG",
      "mobile_number": "92271434",
      "kyc_status": null,
      "status": "SUCCESS",
      "type": "INDIVIDUAL",
      "postal_address": {
        "line1": "123 5th Avenue",
        "line2": null,
        "city": "New York",
        "state": "NY",
        "country": "SG",
        "postcode": "10001"
      },
      "individual": {
        "address": {
          "line1": "123 5th Avenue",
          "line2": null,
          "city": "New York",
          "state": "NY",
          "country": "SG",
          "postcode": "10001"
        },
        "date_of_birth": "1990-01-01",
        "employers": null,
        "name": {
            "title": null,
            "first_name": "John",
            "middle_name": null,
            "last_name": "Doe",
            "name_on_card": null
        }
      },
      "created_at": "2026-08-11 14:48:02",
      "review_status": "SUCCESS"
    }
  ]
}

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

Update Cardholder

This API allows you to update a cardholder profile in the system.

{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder

Description

This endpoint updates cardholder information, including physical address, postal address, and contact details. All fields are optional, and only the fields provided will be updated. For composite objects, such as name, all child fields must be provided and valid when the object is included.

💡 mobile_number and country_code must be provided together. Updating either field individually is not supported.

📩 Request Headers

x-api-key string required

Shared X-API key

x-product-id string required

Shared Product ID

x-request-id string required

Idempotency key for request tracking

x-user-id string required

User identification key

Content-Type string required

Must be application/json

Authorization string required

Bearer access token

📦 Request Body

mobile_number string

Cardholder's mobile number without country code.

💡 See Phone Number Validation Rules for country-specific length requirements.

country_code string

2-letter ISO 3166-1 country code for the individual's mobile number.

individual object

Details about the cardholder.

address object required

Physical address of cardholder

city string required

City of address

country string required

Country code (2-letter ISO 3166-1) of address

line1 string required

Address line 1

line2 string

Address line 2

state string required

Address state

postcode string required

Address postal code

updated_by string required

User updating the details

🔍 Query Parameters

id string required

Unique identifier for cardholder

🧩 Examples

Request Example

cURL
Python
Java
NodeJs

curl --location --request PATCH \
--url '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}' \
--header 'x-api-key: {{Shared X-API key}}' \
--header 'x-product-id: {{Shared ProductID}}' \
--header 'x-request-id: {{IdempotencyKey}}' \
--header 'x-user-id: {{UserID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{AccessToken}}'
--data '{
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  }, 
  "updated_by": "user"
}'

import requests
import json

url = "{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}"

payload = json.dumps({
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  },
  "updated_by": "user"
})
headers = {
  'x-api-key': '{{Shared X-API key}}',
  'x-product-id': '{{Shared ProductID}}',
  'x-request-id': '{{IdempotencyKey}}',
  'x-user-id': '{{UserID}}',
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{AccessToken}}'
}

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

print(response.text)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n      \"individual\": {\r\n        \"address\": {\r\n          \"city\": \"Austin\",\r\n          \"country\": \"US\",\r\n          \"line1\": \"1234 Elm Street\",\r\n          \"state\": \"TX\",\r\n          \"postcode\": \"94932\"\r\n        }\r\n      }, \r\n      \"updated_by\": \"user\"\r\n    }");
Request request = new Request.Builder()
  .url("{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}")
  .method("PATCH", body)
  .addHeader("x-api-key", "{{Shared X-API key}}")
  .addHeader("x-product-id", "{{Shared ProductID}}")
  .addHeader("x-request-id", "{{IdempotencyKey}}")
  .addHeader("x-user-id", "{{UserID}}")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{AccessToken}}")
  .build();
Response response = client.newCall(request).execute();

const axios = require('axios');

let data = JSON.stringify({
  "individual": {
    "address": {
      "city": "Austin",
      "country": "US",
      "line1": "1234 Elm Street",
      "state": "TX",
      "postcode": "94932"
    }
  },
  "updated_by": "user"
});

let config = {
  method: 'patch',
  maxBodyLength: Infinity,
  url: '{{baseUrl}}/hashdt/issuing/api/v1/card/cardholder?id={{CardholderID}}',
  headers: { 
    'x-api-key': '{{Shared X-API key}}', 
    'x-product-id': '{{Shared ProductID}}', 
    'x-request-id': '{{IdempotencyKey}}', 
    'x-user-id': '{{UserID}}', 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer {{AccessToken}}'
  },
  data : data
};

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

Response Example

{
  "status": "success",
  "message": "Cardholder updated successfully.",
  "code": 200
}

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

Create Cardholder​

Description

📩 Request Headers

📦 Request Body

Request Example

Response Example

Get All Cardholders​

Description

📩 Request Headers

🔍 Query Parameters

Request Example

Response Example

Get Cardholder Details​

Description

📩 Request Headers

🔍 Query Parameters

Request Example

Response Example

Update Cardholder​

Description

📩 Request Headers

📦 Request Body

🔍 Query Parameters

Request Example

Response Example

Create Cardholder

Get All Cardholders

Get Cardholder Details

Update Cardholder