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
Update a Counterparty
Update a Counterparty
Headers
API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.
Path Parameters
Body
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
ACH routing number of the counterparty's bank
if the account is verified - true or false
pass, fail, review city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address (optional)
postal code
2-Letter US state abbreviation (ex: CA)
doing business as
email of the business
entity type of the business
sole_proprietor, single_member_llc, limited_liability_company, general_partnership, unlisted_corporation, publicly_traded_corporation, association, non_profit, government_organization, revocable_trust, irrevocable_trust, estate, professional_association, limited_partnership, limited_liability_partnership, professional_corporation date business was formed (YYYY-MM-DD)
- if id_type is ssn, id_number must be full SSN
- if id_type is ein, id_number must be ein 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 businesses
type of the business identity used
ein, other unique id of the KYB
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYB
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
legal name of the business
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address (optional)
postal code
2-Letter US state abbreviation (ex: CA)
true if this member is the control person of the business
true, false date of birth of the person (YYYY-MM-DD)
email of the person
first name of the person
- 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
type of identity used
ssn, passport, other unique id of the KYC
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYC
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
last name of the person
middle name of the person
ownership percentage in the business
phone number of the person (E.164, max 16 chars, starts with +)
title of the member in the business
phone number of the business (E.164, max 16 chars, starts with +)
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
tokenized card number of counterparty's debit card
cvv code of counterparty's debit card
expiration month of counterparty's debit card
expiration year of counterparty's debit card
last4 of counterparty's debit card
if debit pull is enabled or disabled by the debit card issuer
true, false if debit pull is enabled or disabled by the debit card issuer
true, false bank account number of the counterparty
type of counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
Wire routing number of the counterparty's bank
unique id to cross-reference records with external systems
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
FedNow routing number of the counterparty's bank
if the account is verified or not
pass, fail, review bank account number of the counterparty
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter state abbreviation (ex: CA)
SWIFT/BIC code of counterparty's bank
name of counterparty's bank
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
SWIFT/BIC code of counterparty's correspondent bank
name of counterparty's correspondent bank
label of the counterparty
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": ""}
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
date of birth of the person (YYYY-MM-DD)
email of the person
first name of the person
- 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
type of identity used
ssn, passport, other unique id of the IDV
sub account holder IDV method. It could be an external vendor(Ex: plaid) or Solid
status of the IDV
pass, fail, review, not_started url to the identity verification result. It could be a link to the external vendor or Solid
unique id of the KYC
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYC
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
last name of the person
middle name of the person
phone number of the person (E.164, max 16 chars, starts with +)
purpose of counterparty
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
RTP routing number of the counterparty's bank
if the account is verified
pass, fail, review status of counterparty
pending_activation, activated, suspended, deactivated type of counterparty
person, business Response
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
ACH routing number of the counterparty's bank
if the account is verified - true or false
pass, fail, review unique id of the attachment created
label of the attachment
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address (optional)
postal code
2-Letter US state abbreviation (ex: CA)
doing business as
email of the business
entity type of the business
sole_proprietor, single_member_llc, limited_liability_company, general_partnership, unlisted_corporation, publicly_traded_corporation, association, non_profit, government_organization, revocable_trust, irrevocable_trust, estate, professional_association, limited_partnership, limited_liability_partnership, professional_corporation date business was formed (YYYY-MM-DD)
- if id_type is ssn, id_number must be full SSN
- if id_type is ein, id_number must be ein 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 businesses
type of the business identity used
ein, other unique id of the KYB
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYB
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
legal name of the business
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address (optional)
postal code
2-Letter US state abbreviation (ex: CA)
true if this member is the control person of the business
true, false date of birth of the person (YYYY-MM-DD)
email of the person
first name of the person
- 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
type of identity used
ssn, passport, other unique id of the KYC
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYC
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
last name of the person
middle name of the person
ownership percentage in the business
phone number of the person (E.164, max 16 chars, starts with +)
title of the member in the business
phone number of the business (E.164, max 16 chars, starts with +)
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
unique id of the client to which the counterparty belongs
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
tokenized card number of counterparty's debit card
cvv code of counterparty's debit card
expiration month of counterparty's debit card
expiration year of counterparty's debit card
last4 of counterparty's debit card
if debit pull is enabled or disabled by the debit card issuer
true, false if debit pull is enabled or disabled by the debit card issuer
true, false bank account number of the counterparty
type of counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
Wire routing number of the counterparty's bank
unique id to cross-reference records with external systems
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
FedNow routing number of the counterparty's bank
if the account is verified or not
pass, fail, review unique id of the counterparty
bank account number of the counterparty
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter state abbreviation (ex: CA)
SWIFT/BIC code of counterparty's bank
name of counterparty's bank
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
SWIFT/BIC code of counterparty's correspondent bank
name of counterparty's correspondent bank
label of the counterparty
unique id of the master account holder
unique id of the master account
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": ""}
city of the address
2-letter abbreviated country code (ex: US)
line 1 of the address
line 2 of the address
postal code
2-Letter US state abbreviation (ex: CA)
date of birth of the person (YYYY-MM-DD)
email of the person
first name of the person
- 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
type of identity used
ssn, passport, other unique id of the IDV
sub account holder IDV method. It could be an external vendor(Ex: plaid) or Solid
status of the IDV
pass, fail, review, not_started url to the identity verification result. It could be a link to the external vendor or Solid
unique id of the KYC
sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid
status of the KYC
pass, fail, review, not_started url to the person or business verification result. It could be a link to the external vendor or Solid
last name of the person
middle name of the person
phone number of the person (E.164, max 16 chars, starts with +)
purpose of counterparty
bank account number of the counterparty
type of the counterparty's bank account
business_checking, business_savings, personal_checking, personal_savings name of counterparty's bank
RTP routing number of the counterparty's bank
if the account is verified
pass, fail, review status of counterparty
pending_activation, activated, suspended, deactivated, locked unique id of the sub account holder
unique id of the sub account under which the counterparty was created
type of counterparty
person, business