Retrieve a Counterparty

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

counterparty_id

string

required

Response

Retrieve a Counterparty

string

unique id of the counterparty

Example:

"ctp_8e5541c8a9e50c3af3b0daacf9175130"

client_id

string

unique id of the client to which the counterparty belongs

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 under which the counterparty was created

Example:

"sub_bda1e562657c41e553104b10aad3fe70"

label

string

label of the counterparty

Example:

"Development Vendor"

type

enum<string>

type of counterparty

Available options:

person,

business

Example:

"person"

person

object

Show child attributes

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:

"[email protected]"

person.address

object

Show child attributes

person.address.line1

string

line 1 of the address

Example:

"123 Main St"

person.address.line2

string

line 2 of the address

Example:

""

person.address.city

string

city of the address

Example:

"New York"

person.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

person.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

person.address.postal_code

string

postal code

Example:

"10001"

person.kyc

object

Show child attributes

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

Show child attributes

person.kyc.details.name

object

Show child attributes

person.kyc.details.name.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.name.reasons

object[]

Show child attributes

person.kyc.details.name.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.name.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.address

object

Show child attributes

person.kyc.details.address.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.address.reasons

object[]

Show child attributes

person.kyc.details.address.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.address.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.dob

object

Show child attributes

person.kyc.details.dob.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.dob.reasons

object[]

Show child attributes

person.kyc.details.dob.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.dob.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.ssn

object

Show child attributes

person.kyc.details.ssn.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.ssn.reasons

object[]

Show child attributes

person.kyc.details.ssn.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.ssn.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.phone

object

Show child attributes

person.kyc.details.phone.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.phone.reasons

object[]

Show child attributes

person.kyc.details.phone.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.phone.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.email

object

Show child attributes

person.kyc.details.email.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.email.reasons

object[]

Show child attributes

person.kyc.details.email.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.email.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.watchlist

object

Show child attributes

person.kyc.details.watchlist.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.watchlist.reasons

object[]

Show child attributes

person.kyc.details.watchlist.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.watchlist.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.kyc.details.fraud

object

Show child attributes

person.kyc.details.fraud.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

person.kyc.details.fraud.reasons

object[]

Show child attributes

person.kyc.details.fraud.reasons.code

string

reason code

Example:

"N001"

person.kyc.details.fraud.reasons.description

string

description of reason code

Example:

"First name didn't match"

person.idv

object

Show child attributes

person.idv.id

string

unique id of the IDV

Example:

"idv_7948d9a96706dd05360a340002de725f"

person.idv.status

enum<string>

status of the IDV

Available options:

pass,

fail,

review,

not_started

Example:

"pass"

person.idv.method

string

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

Example:

"solid"

person.idv.url

string

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

Example:

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

person.idv.reasons

object[]

Show child attributes

person.idv.reasons.code

string

reason code

Example:

"N001"

person.idv.reasons.description

string

description of reason code

Example:

"First name didn't match"

business

object

Show child attributes

business.legal_name

string

legal name of the business

Example:

"Ace LLC"

business.dba

string

doing business as

Example:

"Ace Inc"

business.entity_type

enum<string>

entity type of the business

Available options:

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

Example:

"limited_liability_company"

business.id_type

enum<string>

type of the business identity used

Available options:

ein,

other

Example:

"ein"

business.id_number

string

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

Example:

"187654321"

business.phone

string

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

Example:

"16604491146"

business.email

string

email of the business

Example:

"[email protected]"

business.formation_date

string

date business was formed (YYYY-MM-DD)

Example:

"2018-02-18"

business.address

object

Show child attributes

business.address.line1

string

line 1 of the address

Example:

"123 Main St"

business.address.line2

string

line 2 of the address (optional)

Example:

""

business.address.city

string

city of the address

Example:

"New York"

business.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

business.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

business.address.postal_code

string

postal code

Example:

"10001"

business.kyb

object

Show child attributes

business.kyb.id

string

unique id of the KYB

Example:

"kyb_7948d9a96706dd05360a340002de725f"

business.kyb.status

enum<string>

status of the KYB

Available options:

pass,

fail,

review,

not_started

Example:

"pass"

business.kyb.method

string

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

Example:

"solid"

business.kyb.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"

business.kyb.details

object

Show child attributes

business.kyb.details.name

object

Show child attributes

business.kyb.details.name.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.kyb.details.name.reasons

object[]

Show child attributes

business.kyb.details.name.reasons.code

string

reason code

Example:

"N001"

business.kyb.details.name.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.kyb.details.address

object

Show child attributes

business.kyb.details.address.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.kyb.details.address.reasons

object[]

Show child attributes

business.kyb.details.address.reasons.code

string

reason code

Example:

"N001"

business.kyb.details.address.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.kyb.details.watchlist

object

Show child attributes

business.kyb.details.watchlist.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.kyb.details.watchlist.reasons

object[]

Show child attributes

business.kyb.details.watchlist.reasons.code

string

reason code

Example:

"N001"

business.kyb.details.watchlist.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.kyb.details.fraud

object

Show child attributes

business.kyb.details.fraud.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.kyb.details.fraud.reasons

object[]

Show child attributes

business.kyb.details.fraud.reasons.code

string

reason code

Example:

"N001"

business.kyb.details.fraud.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members

object[]

Show child attributes

business.members.first_name

string

first name of the person

Example:

"Jane"

business.members.middle_name

string

middle name of the person

Example:

"Jack"

business.members.last_name

string

last name of the person

Example:

"Doe"

business.members.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

Example:

"ssn"

business.members.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"

business.members.date_of_birth

string

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

Example:

"1974-01-01"

business.members.phone

string

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

Example:

"+19418405843"

business.members.email

string

email of the person

Example:

"[email protected]"

business.members.address

object

Show child attributes

business.members.address.line1

string

line 1 of the address

Example:

"123 Main St"

business.members.address.line2

string

line 2 of the address (optional)

Example:

""

business.members.address.city

string

city of the address

Example:

"New York"

business.members.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

business.members.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

business.members.address.postal_code

string

postal code

Example:

"10001"

business.members.ownership

number

ownership percentage in the business

Example:

50.59

business.members.title

string

title of the member in the business

Example:

"CEO"

business.members.control_person

enum<string>

true if this member is the control person of the business

Available options:

true,

false

Example:

"true"

business.members.kyc

object

Show child attributes

business.members.kyc.id

string

unique id of the KYC

Example:

"kyc_7948d9a96706dd05360a340002de725f"

business.members.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

Example:

"pass"

business.members.kyc.method

string

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

Example:

"solid"

business.members.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"

business.members.kyc.details

object

Show child attributes

business.members.kyc.details.name

object

Show child attributes

business.members.kyc.details.name.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.name.reasons

object[]

Show child attributes

business.members.kyc.details.name.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.name.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.address

object

Show child attributes

business.members.kyc.details.address.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.address.reasons

object[]

Show child attributes

business.members.kyc.details.address.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.address.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.dob

object

Show child attributes

business.members.kyc.details.dob.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.dob.reasons

object[]

Show child attributes

business.members.kyc.details.dob.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.dob.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.ssn

object

Show child attributes

business.members.kyc.details.ssn.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.ssn.reasons

object[]

Show child attributes

business.members.kyc.details.ssn.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.ssn.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.phone

object

Show child attributes

business.members.kyc.details.phone.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.phone.reasons

object[]

Show child attributes

business.members.kyc.details.phone.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.phone.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.email

object

Show child attributes

business.members.kyc.details.email.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.email.reasons

object[]

Show child attributes

business.members.kyc.details.email.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.email.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.watchlist

object

Show child attributes

business.members.kyc.details.watchlist.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.watchlist.reasons

object[]

Show child attributes

business.members.kyc.details.watchlist.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.watchlist.reasons.description

string

description of reason code

Example:

"First name didn't match"

business.members.kyc.details.fraud

object

Show child attributes

business.members.kyc.details.fraud.status

enum<string>

Available options:

pass,

fail,

review,

in_review

Example:

"pass"

business.members.kyc.details.fraud.reasons

object[]

Show child attributes

business.members.kyc.details.fraud.reasons.code

string

reason code

Example:

"N001"

business.members.kyc.details.fraud.reasons.description

string

description of reason code

Example:

"First name didn't match"

intra_account

object

Show child attributes

intra_account.sub_account_number

string

sub account number of the counterparty

Example:

"95483674098723"

intra_account.sub_account_id

string

sub account id of the counterparty

Example:

"sub_cda1e562657c41e553104b10aad3fe70"

ach

object

Show child attributes

ach.account_number

string

bank account number of the counterparty

Example:

"98324502"

ach.routing_number

string

ACH routing number of the counterparty's bank

Example:

"121042882"

ach.account_type

enum<string>

type of the counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

Example:

"business_checking"

ach.bank_name

string

name of counterparty's bank

Example:

"Wells Fargo"

ach.verification_status

enum<string>

if the account is verified - true or false

Available options:

pass,

fail,

review

Example:

"pass"

domestic_wire

object

Show child attributes

domestic_wire.account_number

string

bank account number of the counterparty

Example:

"98324502"

domestic_wire.routing_number

string

Wire routing number of the counterparty's bank

Example:

"121042882"

domestic_wire.account_type

enum<string>

type of counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

Example:

"business_checking"

domestic_wire.bank_name

string

name of counterparty's bank

Example:

"Wells Fargo"

international_wire

object

Show child attributes

international_wire.account_number

string

bank account number of the counterparty

Example:

"920020006167511"

international_wire.beneficiary_bank

object

Show child attributes

international_wire.beneficiary_bank.identifier_code

string

SWIFT/BIC code of counterparty's bank

Example:

"ICICINBBNRI"

international_wire.beneficiary_bank.name

string

name of counterparty's bank

Example:

"ICICI Bank"

international_wire.beneficiary_bank.address

object

Show child attributes

international_wire.beneficiary_bank.address.line1

string

line 1 of the address

Example:

"256 Main St"

international_wire.beneficiary_bank.address.line2

string

line 2 of the address

Example:

"Suite 201"

international_wire.beneficiary_bank.address.city

string

city of the address

Example:

"Bengaluru"

international_wire.beneficiary_bank.address.state

string

2-Letter state abbreviation (ex: CA)

Example:

"KA"

international_wire.beneficiary_bank.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"IN"

international_wire.beneficiary_bank.address.postal_code

string

postal code

Example:

"900009"

international_wire.correspondent_bank

object

Show child attributes

international_wire.correspondent_bank.identifier_code

string

SWIFT/BIC code of counterparty's correspondent bank

Example:

"SCBLUS33XXX"

international_wire.correspondent_bank.name

string

name of counterparty's correspondent bank

Example:

"STANDARD CHARTERED BANK"

international_wire.correspondent_bank.address

object

Show child attributes

international_wire.correspondent_bank.address.line1

string

line 1 of the address

Example:

"1095 12th Ave"

international_wire.correspondent_bank.address.line2

string

line 2 of the address

Example:

"Suite 201"

international_wire.correspondent_bank.address.city

string

city of the address

Example:

"New York"

international_wire.correspondent_bank.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

international_wire.correspondent_bank.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

international_wire.correspondent_bank.address.postal_code

string

postal code

Example:

"10001"

rtp

object

Show child attributes

rtp.account_number

string

bank account number of the counterparty

Example:

"98324502"

rtp.routing_number

string

RTP routing number of the counterparty's bank

Example:

"121042882"

rtp.account_type

enum<string>

type of the counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

Example:

"business_checking"

rtp.bank_name

string

name of counterparty's bank

Example:

"Wells Fargo"

rtp.verification_status

enum<string>

if the account is verified

Available options:

pass,

fail,

review

Example:

"pass"

fednow

object

Show child attributes

fednow.account_number

string

bank account number of the counterparty

Example:

"98324502"

fednow.routing_number

string

FedNow routing number of the counterparty's bank

Example:

"121042882"

fednow.account_type

enum<string>

type of the counterparty's bank account

Available options:

business_checking,

business_savings,

personal_checking,

personal_savings

Example:

"business_checking"

fednow.bank_name

string

name of counterparty's bank

Example:

"Wells Fargo"

fednow.verification_status

enum<string>

if the account is verified or not

Available options:

pass,

fail,

review

Example:

"pass"

check

object

Show child attributes

check.address

object

Show child attributes

check.address.line1

string

line 1 of the address

Example:

"123 Main St"

check.address.line2

string

line 2 of the address

Example:

"Suite 201"

check.address.city

string

city of the address

Example:

"New York"

check.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

check.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

check.address.postal_code

string

postal code

Example:

"10001"

debit_card

object

Show child attributes

debit_card.card_number

string

tokenized card number of counterparty's debit card

Example:

"tok_live_6GVyHuQR7aAjCZivYzLbuP_9990"

debit_card.last4

string

last4 of counterparty's debit card

Example:

"9990"

debit_card.expiry_month

string

expiration month of counterparty's debit card

Example:

"10"

debit_card.expiry_year

string

expiration year of counterparty's debit card

Example:

"2024"

debit_card.cvv

string

cvv code of counterparty's debit card

Example:

"tok_live_7CVyHuQR7aAjCZivYzLbuP_9990"

debit_card.address

object

Show child attributes

debit_card.address.line1

string

line 1 of the address

Example:

"123 Main St"

debit_card.address.line2

string

line 2 of the address

Example:

"Suite 201"

debit_card.address.city

string

city of the address

Example:

"New York"

debit_card.address.state

string

2-Letter US state abbreviation (ex: CA)

Example:

"NY"

debit_card.address.country

string

2-letter abbreviated country code (ex: US)

Example:

"US"

debit_card.address.postal_code

string

postal code

Example:

"10001"

debit_card.pull_enabled

enum<string>

if debit pull is enabled or disabled by the debit card issuer

Available options:

true,

false

Example:

"true"

debit_card.push_enabled

enum<string>

if debit pull is enabled or disabled by the debit card issuer

Available options:

true,

false

Example:

"true"

purpose

string

purpose of counterparty

Example:

"Offshore dev center"

external_reference_id

string

unique id to cross-reference records with external systems

Example:

"TW-9L1L2-UVV"

ofac

object

Show child attributes

ofac.status

enum<string>

ofac status of the counterparty

Available options:

pass,

fail

Example:

"pass"

ofac.last_updated_at

string

last date and time at which the counterparty's ofac status was checked

Example:

"2024-04-01T21:00:00Z"

attachments

object[]

Show child attributes

attachments.id

string

unique id of the attachment created

Example:

"att_a8d2b191fa0e960d8e49a4bfd320e07b"

attachments.label

string

label of the attachment

Example:

"formation"

attachments.timestamps

object

Show child attributes

attachments.timestamps.created_at

string

date and time at which the attachment was created

Example:

"2024-04-01T21:00:00Z"

attachments.timestamps.deleted_at

string

date and time at which the attachment was deleted

Example:

"2024-04-01T21:00:00Z"

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 counterparty

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

Example:

"activated"

timestamps

object

Show child attributes

timestamps.created_at

string

date and time at which the counterparty was created

Example:

"2024-04-01T21:00:00Z"

timestamps.updated_at

string

date and time at which the counterparty was updated

Example:

"2024-04-01T21:00:00Z"

timestamps.deactivated_at

string

date and time at which the counterparty was deactivated

Example:

"2024-04-01T21:00:00Z"

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Retrieve a Counterparty

Headers

Path Parameters

Response