Create a Card Holder

POST

issuing

card_holder

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.

Body

application/json

external_reference_id

string

unique id to cross-reference records with external systems

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": ""}

person

object

person.address

object

person.date_of_birth

string

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

person.email

string

email of the person

person.first_name

string

first name of the person

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

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

person.idv

object

person.kyc

object

person.kyc.details

object

person.kyc.id

string

unique id of the KYC

person.kyc.method

string

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

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

person.kyc.url

string

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

person.last_name

string

last name of the person

person.middle_name

string

middle name of the person

person.phone

string

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

purpose

string

purpose of card holder

sub_account_id

string

unique id of the sub account

Response

201 - application/json

attachments

object[]

client_id

string

unique id of the client that issued the card

external_reference_id

string

unique id to cross-reference records with external systems

string

unique id of the card holder

master_account_holder_id

string

unique id of the master account holder

master_account_id

string

unique id of the master account

metadata

object

ofac

object

person

object

person.address

object

person.date_of_birth

string

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

person.email

string

email of the person

person.first_name

string

first name of the person

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

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

person.idv

object

person.kyc

object

person.kyc.details

object

person.kyc.id

string

unique id of the KYC

person.kyc.method

string

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

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

person.kyc.url

string

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

person.last_name

string

last name of the person

person.middle_name

string

middle name of the person

person.phone

string

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

purpose

string

purpose of card holder

status

enum<string>

status of card holder

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

sub_account_holder_id

string

unique id of the sub account holder

sub_account_id

string

unique id of the sub account

timestamps

object

List all Card Holders Retrieve a Card Holder

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Create a Card Holder

Headers

Body

Response