Getting Started
Master Accounts
Sub Account Holders
Sub Accounts
Counterparties
Card Holders
Cards
Transactions
- GETList all Transactions
- POSTSub Ledger a Transaction
- POSTOriginate an Intra Account Push
- POSTOriginate an Intra Account Pull
- POSTOriginate an ACH Push
- POSTOriginate an ACH Pull
- POSTOriginate a Domestic Wire
- POSTOriginate an International Wire
- POSTOriginate an RTP Push
- POSTOriginate a FedNow Push
- POSTOriginate a Debit Card Push
- POSTOriginate a Debit Card Pull
- POSTOriginate a Check Send
- POSTOriginate a Check Deposit
- GETRetrieve a Transaction
- PATCHUpdate a Transaction
Attachments
Webhooks
curl --request POST \
--url https://api.sandbox.solidfi.com/v2/issuing/card_holder \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
"person": {
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"phone": "+19418405843",
"email": "[email protected]",
"date_of_birth": "1974-01-25",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"external_reference_id": "6RPD1QW-W75",
"purpose": "Ace Sales Expense Card",
"metadata": {
"designation": "Senior Sales Manager",
"employee_number": "77"
}
}
'{
"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": "[email protected]",
"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"
}
}Create a Card Holder
Create a Card Holder
curl --request POST \
--url https://api.sandbox.solidfi.com/v2/issuing/card_holder \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"sub_account_id": "sub_bda1e562657c41e553104b10aad3fe70",
"person": {
"first_name": "John",
"middle_name": "",
"last_name": "Doe",
"phone": "+19418405843",
"email": "[email protected]",
"date_of_birth": "1974-01-25",
"address": {
"line1": "123 Main St",
"line2": "",
"city": "New York",
"state": "NY",
"country": "US",
"postal_code": "10001"
}
},
"external_reference_id": "6RPD1QW-W75",
"purpose": "Ace Sales Expense Card",
"metadata": {
"designation": "Senior Sales Manager",
"employee_number": "77"
}
}
'{
"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": "[email protected]",
"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 is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.
"{{api_key}}"
Body
unique id of the sub account
"sub_bda1e562657c41e553104b10aad3fe70"
Show child attributes
Show child attributes
first name of the person
"Jane"
middle name of the person
"Jack"
last name of the person
"Doe"
type of identity used
ssn, passport, other "ssn"
- 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
"945678934"
date of birth of the person (YYYY-MM-DD)
"1974-01-01"
phone number of the person (E.164, max 16 chars, starts with +)
"+19418405843"
email of the person
Show child attributes
Show child attributes
line 1 of the address
"123 Main St"
line 2 of the address
""
city of the address
"New York"
2-Letter US state abbreviation (ex: CA)
"NY"
2-letter abbreviated country code (ex: US)
"US"
postal code
"10001"
Show child attributes
Show child attributes
unique id of the KYC
"kyc_7948d9a96706dd05360a340002de725f"
status of the KYC
pass, fail, review, not_started "pass"
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
"solid"
url to the person or business verification result. It could be a link to the external vendor or Solid
"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
unique id of the IDV
"idv_7948d9a96706dd05360a340002de725f"
status of the IDV
pass, fail, review, not_started "pass"
sub account holder IDV method. It could be an external vendor(Ex: plaid) or Solid
"solid"
url to the identity verification result. It could be a link to the external vendor or Solid
"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"
unique id to cross-reference records with external systems
"6RPD1QW-W75"
purpose of card holder
"Ace Sales Rep"
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": ""}
Response
Create a Card Holder
unique id of the card holder
"cah_a120a61f60dfd40fdb07b2e8bcd1f6f0"
unique id of the client that issued the card
"cli_64c6c87ee9d609f36a6f390dc378a4ce"
unique id of the master account holder
"mah_201e02c581a098a740456c5c19fcfcd6"
unique id of the master account
"mas_743fa071316bc6beaf5dddfd05f49c30"
unique id of the sub account holder
"sah_5ccfeef0adf0cbe2aa0980d2c9505752"
unique id of the sub account
"sub_bda1e562657c41e553104b10aad3fe70"
Show child attributes
Show child attributes
first name of the person
"Jane"
middle name of the person
"Jack"
last name of the person
"Doe"
type of identity used
ssn, passport, other "ssn"
- 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
"945678934"
date of birth of the person (YYYY-MM-DD)
"1974-01-01"
phone number of the person (E.164, max 16 chars, starts with +)
"+19418405843"
email of the person
Show child attributes
Show child attributes
line 1 of the address
"123 Main St"
line 2 of the address
""
city of the address
"New York"
2-Letter US state abbreviation (ex: CA)
"NY"
2-letter abbreviated country code (ex: US)
"US"
postal code
"10001"
Show child attributes
Show child attributes
unique id of the KYC
"kyc_7948d9a96706dd05360a340002de725f"
status of the KYC
pass, fail, review, not_started "pass"
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
"solid"
url to the person or business verification result. It could be a link to the external vendor or Solid
"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
pass, fail, review, in_review "pass"
Show child attributes
Show child attributes
unique id of the IDV
"idv_7948d9a96706dd05360a340002de725f"
status of the IDV
pass, fail, review, not_started "pass"
sub account holder IDV method. It could be an external vendor(Ex: plaid) or Solid
"solid"
url to the identity verification result. It could be a link to the external vendor or Solid
"https://dashboard.solidfi.com/id=kyc_7948d9a96706dd05360a340002de725f"
unique id to cross-reference records with external systems
"6RPD1QW-W75"
purpose of card holder
"Ace Sales Rep"
Show child attributes
Show child attributes
unique id of the attachment created
"att_a8d2b191fa0e960d8e49a4bfd320e07b"
label of the attachment
"formation"
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 of card holder
pending_activation, activated, suspended, deactivated, locked "activated"
Show child attributes
Show child attributes
date and time at which the card holder was created
"2024-04-01T21:00:00Z"
date and time at which the card holder was updated
"2024-04-01T21:00:00Z"
date and time at which the card holder was deactivated
"2024-04-01T21:00:00Z"