Update a Card Holder

PATCH

issuing

card_holder

{card_holder_id}

curl --request PATCH \
  --url https://api.sandbox.solidfi.com/v2/issuing/card_holder/{card_holder_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "person": {
    "first_name": "Johnson"
  }
}'

{
  "id": "cah_a120a61f60dfd40fdb07b2e8bcd1f6f0",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "id_type": "ssn",
    "id_number": "223902234",
    "date_of_birth": "1974-01-25",
    "phone": "+19418405843",
    "email": "john.doe@gmail.com",
    "address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10001"
    }
  },
  "external_reference_id": "6RPD1QW-W75",
  "purpose": "Ace Sales Rep",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "metadata": {
    "designation": "Senior Sales Manager",
    "employee_number": "77"
  },
  "attachments": [
    {
      "label": "Employee Badge",
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "created_at": "2024-04-01T21:00:00Z"
    }
  ],
  "status": "activated",
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-02T21:00:00Z",
    "deactivated_at": "2024-04-02T21:00:00Z"
  }
}

Headers

api-key

string

required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Example:

"{{api_key}}"

Path Parameters

card_holder_id

string

required

Body

application/json

person

object

person.first_name

string

first name of the person

Example:

"Jane"

person.middle_name

string

middle name of the person

Example:

"Jack"

person.last_name

string

last name of the person

Example:

"Doe"

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

Example:

"ssn"

person.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

Example:

"945678934"

person.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

Example:

"1974-01-01"

person.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

Example:

"+19418405843"

person.email

string

email of the person

Example:

"jane.doe@gmail.com"

person.address

object

person.kyc

object

person.kyc.id

string

unique id of the KYC

Example:

"kyc_7948d9a96706dd05360a340002de725f"

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

Example:

"pass"

person.kyc.method

string

sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid

Example:

"solid"

person.kyc.url

string

url to the person or business verification result. It could be a link to the external vendor or Solid

Example:

"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"

person.kyc.details

object

person.idv

object

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"6RPD1QW-W75"

purpose

string

purpose of card holder

Example:

"Ace Sales Rep"

metadata

object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

status

enum<string>

status of card holder

Available options:

pending_activation,

activated,

suspended,

deactivated

Example:

"activated"

Response

200

application/json

Update a Card Holder

string

unique id of the card holder

Example:

"cah_a120a61f60dfd40fdb07b2e8bcd1f6f0"

client_id

string

unique id of the client that issued the card

Example:

"cli_64c6c87ee9d609f36a6f390dc378a4ce"

master_account_holder_id

string

unique id of the master account holder

Example:

"mah_201e02c581a098a740456c5c19fcfcd6"

master_account_id

string

unique id of the master account

Example:

"mas_743fa071316bc6beaf5dddfd05f49c30"

sub_account_holder_id

string

unique id of the sub account holder

Example:

"sah_5ccfeef0adf0cbe2aa0980d2c9505752"

sub_account_id

string

unique id of the sub account

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

person

object

person.first_name

string

first name of the person

Example:

"Jane"

person.middle_name

string

middle name of the person

Example:

"Jack"

person.last_name

string

last name of the person

Example:

"Doe"

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

Example:

"ssn"

person.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

Example:

"945678934"

person.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

Example:

"1974-01-01"

person.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

Example:

"+19418405843"

person.email

string

email of the person

Example:

"jane.doe@gmail.com"

person.address

object

person.kyc

object

person.kyc.id

string

unique id of the KYC

Example:

"kyc_7948d9a96706dd05360a340002de725f"

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

Example:

"pass"

person.kyc.method

string

sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid

Example:

"solid"

person.kyc.url

string

url to the person or business verification result. It could be a link to the external vendor or Solid

Example:

"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"

person.kyc.details

object

person.idv

object

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"6RPD1QW-W75"

purpose

string

purpose of card holder

Example:

"Ace Sales Rep"

ofac

object

attachments

object[]

metadata

object

status

enum<string>

status of card holder

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

Example:

"activated"

timestamps

object

Retrieve a Card Holder List all Cards

curl --request PATCH \
  --url https://api.sandbox.solidfi.com/v2/issuing/card_holder/{card_holder_id} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "person": {
    "first_name": "Johnson"
  }
}'

{
  "id": "cah_a120a61f60dfd40fdb07b2e8bcd1f6f0",
  "client_id": "cli_64c6c87ee9d609f36a6f390dc378a4ce",
  "master_account_holder_id": "mah_201e02c581a098a740456c5c19fcfcd6",
  "master_account_id": "mas_743fa071316bc6beaf5dddfd05f49c30",
  "sub_account_holder_id": "sah_5ccfeef0adf0cbe2aa0980d2c9505752",
  "sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "id_type": "ssn",
    "id_number": "223902234",
    "date_of_birth": "1974-01-25",
    "phone": "+19418405843",
    "email": "john.doe@gmail.com",
    "address": {
      "line1": "123 Main St",
      "line2": "",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postal_code": "10001"
    }
  },
  "external_reference_id": "6RPD1QW-W75",
  "purpose": "Ace Sales Rep",
  "ofac": {
    "status": "pass",
    "last_updated_at": "2024-04-01T21:00:00Z"
  },
  "metadata": {
    "designation": "Senior Sales Manager",
    "employee_number": "77"
  },
  "attachments": [
    {
      "label": "Employee Badge",
      "id": "att_a8d2b191fa0e960d8e49a4bfd320e07b",
      "created_at": "2024-04-01T21:00:00Z"
    }
  ],
  "status": "activated",
  "timestamps": {
    "created_at": "2024-04-01T21:00:00Z",
    "updated_at": "2024-04-02T21:00:00Z",
    "deactivated_at": "2024-04-02T21:00:00Z"
  }
}

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Update a Card Holder

Headers

Path Parameters

Body

Response