Person Entity object
An entity represents a person or organization possessing separate and distinct legal rights. You will create entities for each of your customers or users. An entity is required to create a bank account or a loan object. Read about entities in our data model section for more information.
object parameters
person_details
object
Contains all person details of the legal person entity. Only returned when entity type is PERSON.
first_name
string
First name of the legal person. Must adhere to Fedwire character validation.
last_name
string
Last name of the legal person. Must adhere to Fedwire character validation.
middle_name
string
Middle name of the legal person. Must adhere to Fedwire character validation.
ssn
string
Social Security Number. SSN is required for U.S. citizens. ITIN may be shared in place of SSN.
passport
object
Passport Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Passport number
country_code
string
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Driver's License Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Driver's license number
country_code
string
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
National ID Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
National ID number
country_code
string
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Date of birth (YYYY-MM-DD)
string
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
documents
array of objects
List of documents which are uploaded with the Submit Document API
id
string
Unique identifier for the object
is_root
boolean
Indicates if the entity is the root entity of the platform.
review_reasons
array
List of reasons the entity is in Manual_Review
type
string
Type of entity. PERSON for a person entity.
verification_status
array
Current status of the entity verification. Can be UNVERIFIED, PENDING,MANUAL_REVIEW, VERIFIED, or DENIED
verification_tags
string
A list of verification tags with more details about its identity verification process.
Person Entity object
Business Entity object
A business entity represents a legal business in the Column data model.
object parameters
business_details
object
Contains all business details of the legal business entity. Only returned when entity type is BUSINESS.
address
object
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
A list of all the persons who have ultimate control over funds in the business, whether through ownership or other means.
This is anyone who owns owns 25 percent or more of the business and those who control the funds. If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
first_name
string
First name of the legal person
last_name
string
Last name of the legal person
middle_name
string
Middle name of the legal person
ssn
string
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Passport number
country_code
string
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Driver's license number
country_code
string
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
National ID. SSN, passport, driver's license, or national ID is required.
number
string
National ID number
country_code
string
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Date of birth (YYYY-MM-DD)
string
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Job title of the beneficial owner or control person.
address
object
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
business_name
string
Legal Business Name
ein
string
Employer Identification Number (Tax ID). This may be SSN for a sole proprietorship.
registration_id
object
Registration ID. EIN or Registration ID is required.
number
string
Business registration ID
country_code
string
Country code where the business registration ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
industry
string
Industry in which the business entity operates.
website
string
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
legal_type
string
Type of business. Permitted values are limited-partnership, trust, sole-proprietorship, corporation,llc, general-partnership, professional-association,government,non-profit, other.
state_of_incorporation
string
State in which the business is incorporated. Only postal abbreviations (e.g. AL, CA, DE, ...) are allowed. Only required for a root entity.
year_of_incorporation
string
Year in which the business entity was incorporated. Only required for a root entity.
account_usage
array of strings
Indicates possible uses of the accounts an entity may use at Column. Only required for a root entity.
description
string
Description of the business entity. Only required for a root entity.
payment_volumes
string
Expected payment volumes. Only required for a root entity.
countries_of_operation
array of strings
Countries in which the business currently operates or expects to operate. Only ISO 3166-1 Alpha-2 Country Codes (e.g., US, FR, UK, DE, ...) are allowed. Only required for a root entity.
is_root
boolean
Indicates if the entity is the root entity of the platform.
documents
array of objects
List of documents which are uploaded with the Submit Document API
id
string
Unique identifier for the object
review_reasons
array
List of reasons the entity is in Manual_Review
type
string
Type of entity. BUSINESS for a business entity.
verification_status
array
Current status of the entity verification. Can be UNVERIFIED, PENDING,MANUAL_REVIEW, VERIFIED, or DENIED
verification_tags
string
A list of verification tags with more details about its identity verification process.
Entity object
Create a legal person entity
POST
/entities/person
Creates a legal person entity.
body parameters
first_name
string
Required
First name of the legal person. Must adhere to Fedwire character validation.
last_name
string
Required
Last name of the legal person. Must adhere to Fedwire character validation.
middle_name
string
Optional
Middle name of the legal person. Must adhere to Fedwire character validation.
ssn
string
Required
Social Security Number. SSN is required for U.S. citizens. ITIN may be shared in place of SSN.
passport
object
Optional
Passport Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Optional
Driver's License Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
Optional
National ID Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a legal person entity
PATCH
/entities/person/<entity_id>
Update the information stored for a legal person. Do not use this to change the underlying legal person - only use this if the actual personal information changes (e.g. legal name changes, etc.).
path parameters
entity_id
string
Required
ID of the person entity you're updating
body parameters
first_name
string
Required
First name of the legal person. Must adhere to Fedwire character validation.
last_name
string
Required
Last name of the legal person. Must adhere to Fedwire character validation.
middle_name
string
Optional
Middle name of the legal person. Must adhere to Fedwire character validation.
ssn
string
Required
Social Security Number. SSN is required for U.S. citizens. ITIN may be shared in place of SSN.
passport
object
Optional
Passport Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Optional
Driver's License Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
Optional
National ID Details. Passport, Driver's License or National ID is required for non U.S. citizens.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Create a legal business entity
POST
/entities/business
Creates a legal business entity.
body parameters
ein
string
Required
Employer Identification Number (Tax ID)
registration_id
object
Optional
Registration ID, typically for a non US incorporated company. EIN or Registration ID is required.
number
string
Required
Business registration ID
country_code
string
Required
Country code where the business registration ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
business_name
string
Required
Legal Business Name. Must adhere to Fedwire character validation.
website
string
Optional
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
legal_type
string
Optional
Type of business. Permitted values are limited-partnership, trust, sole-proprietorship, corporation,llc, general-partnership, professional-association,government,non-profit, other.
state_of_incorporation
string
Optional
State in which the business is incorporated. Only postal abbreviations (e.g. AL, CA, DE, ...) are allowed. Only required for a root entity.
year_of_incorporation
string
Optional
Year in which the business entity was incorporated. Only required for a root entity.
account_usage
array of strings
Optional
Indicates possible uses of the accounts an entity may use at Column. Only required for a root entity.
description
string
Optional
Description of the business entity. Only required for a root entity.
payment_volumes
string
Optional
Expected payment volumes. Only required for a root entity.
countries_of_operation
array of strings
Optional
Countries in which the business currently operates or expects to operate. Only ISO 3166-1 Alpha-2 Country Codes (e.g., US, FR, UK, DE, ...) are allowed. Only required for a root entity.
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
Required
A list of all the persons who have ultimate control over funds in the business, whether through ownership or other means.
This is anyone who owns owns 25 percent or more of the business and those who control the funds. If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Optional
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Optional
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Optional
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
Optional
National ID. SSN, passport, driver's license, or national ID is required.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Required
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Required
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Optional
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Optional
Job title of the beneficial owner or control person.
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a legal business entity
PATCH
/entities/business/<entity_id>
This updates the information stored for this legal person. Changes to ssn, date of birth, and name will cause a re-verification process. Do not use this to change the underlying legal person - only use this if the actual personal information changes (e.g. legal name changes, etc.).
path parameters
entity_id
string
Required
ID of the business entity you're updating
body parameters
business_name
string
Optional
Legal Business Name. Must adhere to Fedwire character validation.
industry
string
Optional
Industry in which the business entity operates.
website
string
Optional
Website of the business. Optional, but highly encouraged as it will increase likelihood of an automated verification.
legal_type
string
Optional
Type of business. Permitted values are limited-partnership, trust, sole-proprietorship, corporation,llc, general-partnership, professional-association,government,non-profit, other.
state_of_incorporation
string
Optional
State in which the business is incorporated. Only postal abbreviations (e.g. AL, CA, DE, ...) are allowed. Only required for a root entity.
year_of_incorporation
string
Optional
Year in which the business entity was incorporated. Only required for a root entity.
account_usage
array of strings
Optional
Indicates possible uses of the accounts an entity may use at Column. Only required for a root entity.
description
string
Optional
Description of the business entity. Only required for a root entity.
payment_volumes
string
Optional
Expected payment volumes. Only required for a root entity.
countries_of_operation
array of strings
Optional
Countries in which the business currently operates or expects to operate. Only ISO 3166-1 Alpha-2 Country Codes (e.g., US, FR, UK, DE, ...) are allowed. Only required for a root entity.
address
object
Optional
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
beneficial_owners
array of objects
Optional
If beneficial owners are updated, the entire array of objects will be updated. This means you must pass the complete array of beneficial owners when updating.
A list of all the persons who have ultimate control over funds in the business, whether through ownership or other means.
This is anyone who owns owns 25 percent or more of the business and those who control the funds. If no one owns more than 25% of the business, just the individual who has ultimate control of the funds must be included.
first_name
string
Required
First name of the legal person
last_name
string
Required
Last name of the legal person
middle_name
string
Optional
Middle name of the legal person
ssn
string
Optional
Social Security Number is required for US beneficial owners. Passport, driver's license, or national ID is required for foreign beneficial owners.
passport
object
Optional
Passport Number. SSN, passport, driver's license, or national ID is required.
number
string
Required
Passport number
country_code
string
Required
Country code where the passport was issued. US Passports will be rejected as we require US citizens to submit SSN.
drivers_license
object
Optional
Driver's license. SSN, passport, driver's license, or national ID is required.
number
string
Required
Driver's license number
country_code
string
Required
Country code where the driver's license was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...). US Drivers License will be rejected as we require US citizens to submit SSN.
national_id
object
Optional
National ID. SSN, passport, driver's license, or national ID is required.
number
string
Required
National ID number
country_code
string
Required
Country code where the national ID was issued. ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
date_of_birth
string
Required
Date of birth (YYYY-MM-DD)
string
Optional
Email of the individual. Optional, but highly encouraged as it will increase likelihood of an automated verification.
is_control_person
boolean
Required
Boolean value which specifies if this person is a designated control person.
is_beneficial_owner
boolean
Required
Boolean value which specifies if this person is a designated beneficial owner.
ownership_percentage
integer
Optional
Percentage ownership, specified as a integer, of the beneficial owner
job_title
string
Optional
Job title of the beneficial owner or control person.
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Get an entity by ID
GET
/entities/<entity_id>
Retrieve a single legal entity by its ID.
path parameters
entity_id
string
Required
ID of the entity you're requesting. Depending on the entity type, either the business or person object will be returned.
Request
Response
Delete an entity
DELETE
/entities/<entity_id>
Delete the underlying entity.
Removing entities
Entities can only be deleted if all their underlying accounts are deleted. Accounts can only be deleted when they have a $0 balance.
path parameters
entity_id
string
Required
ID of the entity you're deleting.
Request
Response
List all entities
GET
/entities
Retrieve all entities on your platform. Filtered results can be retrieved with extra parameters in the query (`type`, `name`, etc.).
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
type
string
Optional
Return results with this entity type, either PERSON or BUSINESS.
verification_status
string
Optional
Return results with this verification status.
is_root
boolean
Optional
Indicates if the entity is the root entity of the platform.
name
string
Optional
Return entities with this name.
Request
Response
Submit a document
POST
/entities/<entity_id>/documents
Submit a supporting document for manual review of an entity.
path parameters
entity_id
string
Required
ID of the entity for which a supporting document is being submitted.
body parameters
document_front_id
string
Required
ID of the entity for which a supporting document is being submitted.
Accepted formats for person entities: PNG, JPEG, GIF, and TIFF.
document_back_id
string
Optional
ID of the back of the document that is being submitted, starting with docu_. The document must be uploaded first via Document Upload API. This is only required for some forms of documentation. For most documents, only the front side is required.
Accepted formats for person entities: PNG, JPEG, GIF, and TIFF.
description
string
Optional
Description of why the document is being submitted for review. Maximum length: 127 characters.
Request
Response
Bank Account object
A bank account is the object in the Column data model that has the ability to hold, send, and receive funds. Bank accounts are children of entities. An entity can have multiple bank accounts. Bank accounts can have one or multiple account numbers. Read about bank accounts in our data model section for more information.
object parameters
balances
object
Lists all possible balance amounts for an account represented in the smallest unit of the currency.
available_amount
int64
This balance is the amount of money that is available to spend. If the account is not enabled for overdrafts, any requests to move money above this number will fail.
holding_amount
int64
The balance of money which is currently in a HOLD state specified in the Create Book Transfer API.
locked_amount
int64
Only applicable for root accounts. The locked balance is posted on the account but cannot be withdrawn.
pending_amount
int64
The total amount of transfers that are in a pending state. These transfers will affect the available_balance unless they are canceled prior to completion.
bic
string
The Swift BIC code for this bank account for international wire payments.
created_at
string
The timestamp at which the bank account was created.
currency_code
string
Currency of the balances in the account. For all amounts this will be USD.
default_account_number
string
The externally facing default account number tied to this bank account.
default_account_number_id
string
The default account number ID tied to this account.
description
string
A name for the bank account (mininum: 3 characters)
id
string
Unique ID for this account.
is_overdraftable
boolean
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
overdraft_reserve_account_id
string
The overdraft reserve account that this account linked to. If is_overdraftable: true then this field is required.
owners
array
List of entity_id's which are tied to this bank account
routing_number
string
The 9-digit ABA routing number for this bank account.
type
string
Bank Account type. Can be CHECKING, OVERDRAFT_RESERVE, or PROGRAM_RESERVE
display_name
string
The display name for the bank account. Display name is an account nickname used on Column's Dashboard.
Bank Account object
Create a new bank account
POST
/bank-accounts
Creates a new bank account under an entity.
body parameters
description
string
Required
A name for the bank account (minimum of three characters)
entity_id
string
Required
The entity to create the account under
is_overdraftable
boolean
Optional
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
overdraft_reserve_account_id
string
Optional
The overdraft reserve account that this account linked to. If `is_overdraftable: true` then this field is required
display_name
string
Optional
The display name for the bank account. Display name is an account nickname used on Column's Dashboard.
Request
Response
List all bank accounts
GET
/bank-accounts
List all bank accounts under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
entity_id
string
Optional
List all accounts that belong to the entity with the entity_id.
is_overdraftable
boolean
Optional
List all accounts that are overdraftable.
type
string
Optional
Bank Account type. Can be CHECKING, OVERDRAFT_RESERVE, or PROGRAM_RESERVE.
overdraft_reserve_account_id
string
Optional
List all bank accounts with the given overdraft_reserve_account_id.
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Get a bank account by ID
GET
/bank-accounts/<bank_account_id>
Get a bank account by its id
path parameters
bank_account_id
string
Required
The ID of the bank account you are looking up
Request
Response
Update a bank account
PATCH
/bank-accounts/<bank_account_id>
Updates a bank account by its id
path parameters
bank_account_id
string
Required
body parameters
description
string
Optional
is_overdraftable
boolean
Optional
Whether the account can be overdrafted, must include a overdraft_reserve_account_id
overdraft_reserve_account_id
string
Optional
The overdraft reserve account that this account linked to if is_overdraftable is true
display_name
string
Optional
The display name for the bank account. Display name is an account nickname used on Column's Dashboard.
is_ach_debitable
boolean
Optional
A boolean value which specifies if the account can be debited by an external RDFI. If set to false, Column will automatically return any debits to this account.
Request
Response
Delete a bank account
DELETE
/bank-accounts/<bank_account_id>
This deletes a bank account
Removing accounts
Bank Accounts can only be deleted when they have a $0 balance.
path parameters
bank_account_id
string
Required
Request
Response
Bank Account Summary object
object parameters
available_balance_credit
string
Total credit amount in cents applied to available_balance. Zero or positive.
available_balance_debit
string
Total debit amount in cents applied to available_balance. Zero or negative.
available_balance_close
string
Close available_balance in cents at the end of effective_on in time_zone.
currency
string
The currency of the balances.
effective_on
string
Effective date of the summary.
holding_balance_credit
string
Total credit amount in cents applied to holding_balance. Zero or positive.
holding_balance_debit
string
Total debit amount in cents applied to holding_balance. Zero or negative.
holding_balance_close
string
Close holding_balance in cents at the end of effective_on in time_zone.
locked_balance_credit
string
Total credit amount in cents applied to locked_balance. Zero or positive.
locked_balance_debit
string
Total debit amount in cents applied to locked_balance. Zero or negative.
locked_balance_close
string
Close locked_balance in cents at the end of effective_on in time_zone.
pending_balance_credit
string
Total credit amount in cents applied to pending_balance. Zero or positive.
pending_balance_debit
string
Total debit amount in cents applied to pending_balance. Zero or negative.
pending_balance_close
string
Close pending_balance in cents at the end of effective_on in time_zone.
time_zone
string
Time zone of effective_on to decide day boundaries. You can set your platform reporting time zone in Platform Settings on Dashboard.
transaction_count
int32
Total number of transactions on the day of effective_on.
Bank Account Summary object
Get bank account summary history
GET
/bank-accounts/<bank_account_id>/history
Get the summary history of a bank account. This endpoint returns a list of summaries, one summary per day, for a single bank account. You must set your platform reporting time zone in Platform Settings on Dashboard to use this endpoint (read more).
path parameters
bank_account_id
string
Required
The ID of the bank account you are looking up
query parameters
from_date
string
Required
Starting date of the history. Format: YYYY-MM-DD.
to_date
string
Required
Ending date of the history. Format: YYYY-MM-DD. Maximum date range: 31 days.
Request
Response
Bank Account Overdraft Alert
A bank account overdraft alert is a notification when an account in your platform has been overdrawn and funds have been locked in your reserve accounts, or has been credited and locked funds in your reserve accounts have been released. Read more.
object parameters
available_balance
object
The current available balance of the bank account after this alert.
cents
int64
Amount in cents
currency_code
string
Amount currency. The three-letter currency code defined in ISO 4217 (e.g. USD)
bank_account_id
string
ID of the bank account that is overdrawn or credited.
overdraft_amount
object
The amount that has been locked or released in the reserve account.
cents
int64
Amount in cents
currency_code
string
Amount currency. The three-letter currency code defined in ISO 4217 (e.g. USD)
reserve_account_id
string
ID of the reserve account in which funds are locked or released.
transfer_id
string
ID of transfer that triggered this alert.
Bank Account object
Account number object
An account number is the child of a bank account. A bank account can have one or more account numbers. Think of account numbers as a pointer to a bank account. Account numbers will be used by external banks to transact with Column bank accounts. Read about account numbers in our data model section for more information.
object parameters
account_number
string
The externally facing account number tied to this bank account.
bank_account_id
string
The Column bacc_id tied to this bank account.
bic
string
The Swift BIC code for this bank account for international wire payments.
created_at
string
The timestamp the account number was created.
description
string
A name for the account number (minimum of three characters)
id
string
The unique id of the object
routing_number
string
The 9-digit ABA routing number for this bank account.
Account Number object
Create a new account number
POST
/bank-accounts/<bank_account_id>/account-numbers
Creates a new account number that points to the associated bank account
path parameters
bank_account_id
string
Required
The bank account that you want the new account number to point to
body parameters
description
string
Optional
A description for this account number
Request
Response
List all account numbers from a bank account
GET
/bank-accounts/<bank_account_id>/account-numbers
Lists all the account numbers that point to a specific bank account
path parameters
bank_account_id
string
Required
The bank account that you want the new account number to point to
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
Request
Response
Get an account number
GET
/account-numbers/<account_number_id>
Lists all the account numbers that point to a specific bank account
path parameters
account_number_id
string
Required
The id for the account number
Request
Response
Loan object
A loan is an object that lives under an entity, at the same level as a bank account. Just like entities can have multiple bank accounts, entities can have multiple loans. Loans are the foundation for many lending-oriented use cases such as charge cards and term loans. Read about loans in our data model section for more information.
object parameters
balances
object
principal_charged_off
string
The balance of the loan which has been charged off.
principal_holding
string
The balance of the loan which is in a holding state.
principal_outstanding
string
The balance of the loan which is outstanding.
principal_paid
string
The balance of the loan which has been paid.
charged_off_at
string
The timestamp the loan was charged off.
created_at
string
The timestamp the loan was created.
currency
string
The currency of the loan. Currently only USD is supported.
delinquent_at
string
The timestamp the loan was marked as delinquent.
description
string
The description of the loan in the Column dashboard.
disputed_at
string
The timestamp the loan was marked as disputed.
id
string
The id of the loan object.
is_revolving
boolean
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
The maturity date of the loan.
max_principal_balance
string
The max principal balance of the loan. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
paid_off_at
string
The timestamp the loan is marked as paid off.
primary_signer_entity_id
string
The Column entity_id which the loan is related to.
status
string
The current status of the loan. A loan can have a status of current, delinquent, charged_off, in_dispute, canceled or paid_off.
Loan object
Create a new loan
POST
/loans
Creates a new loan under an entity.
body parameters
currency
string
Required
The three-letter currency code defined in ISO 4217. e.g. USD
description
string
Required
The description of the loan in the Column dashboard.
entity_id
boolean
Required
The entity to create the loan under.
is_revolving
boolean
Required
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
Required
The maturity date of the loan
max_principal_balance
string
Required
The max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
e.g. $1.75 would be represented by 175.
Request
Response
Update a loan
PATCH
/loans/<loan_id>
Updates a loan by its ID.
path parameters
loan_id
string
Required
The ID of the loan you are looking up
body parameters
description
string
Optional
The description of the loan in the Column dashboard.
is_revolving
boolean
Optional
Indicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
maturity_date
string
Optional
The maturity date of the loan.
max_principal_balance
string
Optional
The max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
e.g. $1.75 would be represented by 175.
status
string
Optional
The current status of the loan. A loan can have a status of current, delinquent, charged_off, in_dispute, canceled or paid_off.
Request
Response
Get a loan by ID
GET
/loans/<loan_id>
Retrieve a single loan by its ID.
path parameters
loan_id
string
Required
The ID of the loan you are looking up
Request
Response
List all loans
GET
/loans
List all loans under the platform. Filtered results can be retrieved with extra parameters in the query
query parameters
entity_id
string
Optional
status
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Create a disbursement
POST
/loans/disbursements
Creates a disbursement for a loan.
body parameters
amount
string
Required
Amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
bank_account_id
string
Required
The bank account to which funds will be disbursed.
currency
string
Required
The currency of the loan. Currently only USD is supported.
description
string
Required
The description of the loan disbursement.
hold
boolean
Optional
If true, creates a disbursement in a hold state. The disbursement will not be completed until the clear API is called. Disbursements in a hold state may be updated or canceled.
loan_id
string
Required
The ID of the loan to from which the disbursement is being made.
details
object
Optional
Transfer monitoring details
sender_name
string
Optional
Name of the sender
merchant_name
string
Optional
Name of the merchant for this transaction
merchant_category_code
string
Optional
Category code for the merchant for this transaction
authorization_method
string
Optional
Authorization method for this transaction
website
string
Optional
Website for this transaction
internal_transfer_type
string
Optional
Transfer type in non-column systems
statement_description
string
Optional
Line item on the customer statement for the transfer
address
object
Required
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
Request
Response
Update a disbursement
PATCH
/loans/disbursements/<disbursement_id>
Update a disbursement by its ID. Disbursement must be in a "hold" state. Only the amount can be updated.
path parameters
disbursement_id
string
Required
The ID of the disbursement you want to update.
body parameters
amount
string
Required
Amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
currency
string
Required
The currency of the loan. Currently only USD is supported.
Request
Response
Clear a disbursement
POST
/loans/disbursements/<disbursement_id>/clear
Clears a disbursement by its ID. Disbursements can only be cleared if they are in a "hold" state.
path parameters
disbursement_id
string
Required
The ID of the disbursement to clear.
body parameters
amount
string
Optional
Updated amount (in cents) of the funds that will be disbursed.
e.g. $1.75 would be represented by 175.
currency
string
Optional
The currency of the loan. Currently only USD is supported.
Request
Response
Cancel a disbursement
POST
/loans/disbursements/<disbursement_id>/cancel
Cancels a disbursement by its ID. Only a disbursement in a "hold" state can be cancelled.
path parameters
disbursement_id
string
Required
The ID of the disbursement to clear.
Request
Response
Get a disbursement
GET
/loans/disbursements/<disbursement_id>
Get a disbursement by its ID.
path parameters
disbursement_id
string
Required
The ID of the disbursement you are looking up.
Request
Response
List all disbursements
GET
/loans/disbursements
List all disbursements under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
loan_id
string
Optional
bank_account_id
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Create a payment
POST
/loans/payments
Creates a payment for a loan.
body parameters
principal_amount
string
Required
Amount (in cents) of the loan payment.
e.g. $1.75 would be represented by 175.
bank_account_id
string
Required
The bank account from which the payment is originated. The balance of the bank account will decrease by the payment amount.
currency
string
Required
The currency of the loan. Currently only USD is supported.
description
string
Required
The description of the loan payment.
loan_id
string
Required
The ID of the loan to which the payment is being made. The principal_outstanding of the loan will decrease by the payment amount.
Request
Response
Get a payment
GET
/loans/payments/<payment_id>
Get a payment by its ID.
path parameters
payment_id
string
Required
The ID of the payment you are looking up.
Request
Response
List all payments
GET
/loans/payments
List all payments under the platform. Filtered results can be retrieved with extra parameters in the query.
query parameters
loan_id
string
Optional
bank_account_id
string
Optional
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
Request
Response
Counterparty object
A counterparty is an external account that you can transfer money to and from. All ACH and Wire transfers originated by Column take in a counterparty_id to identify the transfer destination. Once you have created a counterparty, you can send money to it (or pull from it)! A counterparty stores an external bank account and can also store additional transaction details, as desired or required. Read about counterparties in our data model section for more information.
object parameters
account_number
string
The account number for the bank account.
account_type
string
The type of the account number. Can be checking or savings.
address
object
Addresses need to adhere to character validation, as addresses are used across multiple payment rails. Characters are validated according to the Fedwire character validation.
line_1
string
Address line 1
line_2
string
Address line 2
city
string
City
state
string
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
created_at
string
The timestamp the object was created.
description
string
Description of the counterparty visible only in your platform. Maximum length: 127 characters.
string
The email address of the beneficiary.
id
string
The unique id of the object
is_column_account
boolean
Indicates whether this counterparty account is actually a Column account.
legal_id
string
The legal ID (e.g., Tax ID, Cedula Juridica, etc.) of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.
legal_type
string
The legal entity type of the beneficiary. Can be business, non_profit, individual, or sole_proprietor. This field is recommended for international wire transfers, and required in some countries.
local_account_number
string
The local account number (e.g. Cuenta Cliente in Costa Rica) in the beneficiary's bank. This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
local_bank_code
string
The local bank code of the beneficiary's bank (e.g., India IFSC, Australia BSB, China CNAPS, etc.). This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters.
name
string
The counterparty name who owns the bank account. For domestic wires, only the first 35 characters are included in the wire message. For international wires, only the first 140 characters are included in the wire message. Additional characters will be truncated.
phone
string
The phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.
Format for international wire transfers: \+[0-9]{1,3}-[0-9()+\-]{1,30} (e.g. +44-(0)1223-333300).
Format for domestic wire transfers:
+1-(650)123-4567(US international phone number format)650-123-4567(650)123-4567(650) 123-4567650 123 45676501234567
routing_number
string
The routing number of the bank.
routing_number_type
string
The type of the routing number. Can be aba, bic, or other.
updated_at
string
The timestamp the object was last updated.
wire_drawdown_allowed
boolean
Whitelists counterparties for automatic approval of drawdown requests to Column via FedWire. If false, all inbound drawdown requests from this counterparty will require explicit approval.
Counterparty object
Create a counterparty
POST
/counterparties
A counterparty is the legal entity on the other side of the transaction. Depending on the type of transaction, we may need to know more or less about them.
A domestic ACH only requires a counterparty's account and routing number. If you include a counterparty name, Column will by default populate receiver_name on the ACH transfer request. Domestic and international wires require full name and address. Certain countries may require additional fields. Learn more about country-specific details here.
body parameters
routing_number
string
Required
The routing number of the bank.
routing_number_type
string
Optional
The type of the routing number. Can be aba or bic. Default value is aba if this field is not set.
account_number
string
Required
The account number of the bank account.
account_type
string
Optional
The type of the account number. Can be checking or savings.
description
string
Optional
Description of the counterparty visible only in your platform. Maximum length: 127 characters.
wire_drawdown_allowed
boolean
Optional
Whitelists counterparties for automatic approval of drawdown requests to Column via FedWire. If false, all inbound drawdown requests from this counterparty will require explicit approval.
name
string
Optional
The account holder on the counterparty bank account. This field is not required to send ACH transfers, but is required to send domestic and international wires. For international wires, Must adhere to International Wire character validation . Column will truncate name to a maximum length of 140 characters per SWIFT guidelines. For domestic wires, Must adhere to FedWire character validation . Column will truncate name to 35 characters per Fedwire guidelines.
address
object
Optional
The address object is not required to send ACH transfers, but is required to send domestic and international wires.
line_1
string
Required
Address line 1
line_2
string
Optional
Address line 2
city
string
Required
City
state
string
Optional
State name. For US addresses, this field is mandatory and only postal abbreviations (e.g. AL, CA, DE, ...) are allowed.
postal_code
string
Optional
Postal code. The following postal code validations apply. CN: ^\d6$, DE: ^\d5$, FR: ^\d5$, GB: ^[A-Z]{1,2}d[A-Z0-9]? ?d[A-Z]{2}$, JP: ^\d3-\d4$, US: ^\d5(?:-\d4)?$
country_code
string
Required
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
phone
string
Optional
The phone number of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 31 characters.
Format for international wire transfers: \+[0-9]{1,3}-[0-9()+\-]{1,30} (e.g. +44-(0)1223-333300).
Format for domestic wire transfers:
+1-(650)123-4567(US international phone number format)650-123-4567(650)123-4567(650) 123-4567650 123 45676501234567
string
Optional
The email address of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters.
legal_id
string
Optional
The legal ID (e.g., Tax ID, Cedula Juridica, etc.) of the beneficiary. This field is recommended for international wire transfers, and required in some countries. Maximum length: 127 characters. For international wires, Must adhere to International Wire character validation .
legal_type
string
Optional
The legal entity type of the beneficiary. Can be business, non_profit, individual, or sole_proprietor. This field is recommended for international wire transfers, and required in some countries. For international wires, Must adhere to International Wire character validation .
local_bank_code
string
Optional
The local bank code of the beneficiary's bank (e.g., India IFSC, Australia BSB, China CNAPS, etc.). This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters. For international wires, Must adhere to International Wire character validation .
local_account_number
string
Optional
The local account number (e.g. Cuenta Cliente in Costa Rica) in the beneficiary's bank. This field is recommended for international wire transfers, and required in some countries. Maximum length: 63 characters. For international wires, Must adhere to International Wire character validation .
Request
Response
List all counterparties
GET
/counterparties
Retrieve all counterparties under your developer account. Filtered results can be retrieved with extra parameters in the query (account_number, routing_number, etc.).
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
created.gt
date-time
Optional
Return results where the specified time field is greater than this value.
created.gte
date-time
Optional
Return results where the specified time field is greater than or equal to this value.
created.lt
date-time
Optional
Return results where the specified time field is less than this value.
created.lte
date-time
Optional
Return results where the specified time field is less than or equal to this value.
account_number
string
Optional
Return counterparties created with given account number.
routing_number
string
Optional
Return counterparties created with given routing number.
Request
Response
Get a counterparty by ID
GET
/counterparties/<counterparty_id>
Retrieve a single counterparty by its ID.
path parameters
counterparty_id
string
Required
ID of the counterparty you're looking up.
Request
Response
Delete a counterparty
DELETE
/counterparties/<counterparty_id>
Delete a counterparty
path parameters
counterparty_id
string
Required
ID of the counterparty you're deleting.
Request
Response
Financial Institution object
object parameters
ach_eligible
bool
Indicates if an institution accepts ACH transfers or not.
check_eligible
bool
Indicates if an institution supports check deposits or not.
city
string
Institution's address city name.
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
created_at
string
The timestamp the object was created.
full_name
string
Institution's official full name.
phone_number
string
Institution's phone number. Only available if ach_eligible = true.
routing_number
string
Institution's routing number. Can be 9-digit ABA routing numbers, or 8/11-character BICs.
routing_number_type
string
The type of the routing number. Can be aba or bic, or other.
short_name
string
Institution's short name.
state
string
Institution's address state code (e.g., CA)
street_address
string
Institution's street address. Only available if ach_eligible = true.
updated_at
string
The timestamp the object was last updated.
wire_eligible
bool
Indicates if an institution accepts wire transfers or not.
wire_settlement_only
bool
Indicates if an institution can only accept bank-to-bank settlement transfers, but cannot accept customer transfers.
zip_code
string
Institution's address zip code. Only available if ach_eligible = true.
Financial Institution object
Get a financial institution
GET
/institutions/<routing_number>
Retrieve a single financial institution by its ABA number or BIC.
path parameters
routing_number
string
Required
ABA number or BIC of the financial institution you're requesting
Request
Response
List financial institutions
GET
/institutions
List all financial institutions. Filtered results can be retrieved with extra parameters in your queires.
query parameters
limit
int32
Optional
A limit of the number of objects to be returned, between 1 and 100. The default is 10.
starting_after
string
Optional
A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.
ending_before
string
Optional
A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo=, your subsequent call can include ending_before=foo_ZXhhbXBsZQo= in order to fetch the previous page of the list.
country_code
string
Optional
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...).
name
string
Optional
Case-insensitive keywords in full names of financial institutions.
routing_number_type
string
Optional
The type of the routing number. Can be aba or bic.
Request
Response
IBAN validation object
object parameters
account_number
string
Account number in the financial institution.
bank_id
string
Local bank code of the financial institution in its country.
bic
string
BIC of the financial institution.
branch_id
string
Branch ID of the financial institution.
check_digits
string
Check digits of the IBAN.
country_code
string
ISO 3166-1 Alpha-2 Country Code (e.g., US, FR, UK, DE, ...) of the financial institution.
iban
string
The IBAN you are validating
institution_name
string
Name of the financial institution.
national_id
string
National ID of the financial institution in its country, which usually consists of its bank_id and branch_id.
IBAN validation object
Validate an IBAN
GET
/iban/<iban>
Validate the format of an IBAN and if it is registered with the given financial institution. However, we cannot verify if the account is still open.
path parameters
iban
string
Required
IBAN you're requesting