kyc_status
and the status
of each requested endorsement, e.g.base
endorsement for access to US rails.
If Bridge is able to validate the information, the customer will receive KYC approval and be granted the requested endorsement(s) to use Bridge’s platform.
If certain information was invalid or missing, the customer object will return the appropriate KYC status, endorsement status, and endorsement requirements.
After obtaining a signed_agreement_id
(details here: Terms of Service), you can now use the Customers API to create customers as follows.
Individual customer creation
You can use the following endpoint.proof_of_address_document
may be required for individual customers from European Economic Area (EEA)
, or customers who wish to use SEPA/Euro services offered by Bridge, if conflicting location signals are detected. Please refer to SEPA/Euro Transactions page for details.
For international customers, submit an ISO 3166-1 alpha-3 country code and an ISO 3166-2 subdivision code (minus the country prefix) for the state. So for the above example, GB-MAN
is the code, but just MAN
is submitted.
Business customer creation
Customer status
Upon customer creation, Bridge will review the submitted customer information and return statuses for both overall KYC (kyc_status
) as well as a status for each requested endorsement (e.g. base
, the endorsement for US rails, will have its own status
). Bridge recommends using both kyc_status
and endorsement status
to determine the customer’s ability to use the Bridge platform.
KYC status
Upon customer creation, Bridge will review all KYCs for the customer and return astatus
field that denotes the KYC status (as applicable) for the user (example KYC statuses include not_started
, active
, or rejected
). The average decision time for KYC is typically less than one minute. If a manual review is required for KYC, the decision may take until next business day. KYB reviews typically happen same business day, up to next business day.
Response
not_started
->active
- This is our happy path for individual customers. The customer information was submitted, and quickly passed via automated checks within seconds.
not_started
->under_review
->approved/rejected
- All business customers and some individual customers may require the Bridge Compliance team to do due diligence of vetting customers manually before the reach a terminal status.
not_started
->rejected

KYC rejection
Sometimes, your customer could immediately move from not_started to rejected and skip under_review entirely. The primary reason this happens is when the tax identification number is entered incorrectly. Without a valid tax identification number, Bridge is unable to verify any of the other details you have submitted for your customer (birth date, address, name, or business details). In this scenario, the customer starts offnot_started
, but after attempting to verify submitted information, there was an issue detected with the submission. It is possible to move directly to rejected
and skip under_review
entirely. In the rejected
scenario, fetching the customer via Get Customer would result in something like this:
rejected
and that there are two fields shared with rejection reasons:
developer_reason
is meant to be used by developers for internal purposes only. This field can contain sensitive information intended for only the developer and is provided to help with troubleshooting potential issues or protecting against potential abuse.reason
can be shared by a developer directly with their customers.
developer_reason
and reason
mappings for KYC rejection reasons.
Updating Customers
Customer information can be updated atPUT /customers/:id
. This endpoint accepts the same shape of data as the creation endpoint.
Notes:
- Even if information was submitted in the first attempt and has not changed, it must still be submitted in the update.
- Bridge currently supports partial updates (e.g., not including all fields in the request) only the following parameters are included:
endorsements, residential_address, physical_address, verified_proof_of_address_at, documents
(with purpose = proof_of_address)
- Bridge currently supports partial updates (e.g., not including all fields in the request) only the following parameters are included:
- Updating the customer object won’t clear their rejection reasons from earlier attempts, but that won’t prevent them passing KYC.
Supported Government ID’s by Country
Government IDs by Country
Government IDs by Country
Y = Yes (Supported) | * (Requires backside )
Country code | Country | Subdivision | Passport extraction | Passport verification | Driver License extraction | Driver License verification | National ID extraction | National ID verification | Other extraction | Other verification | (Requires backside: *) |
---|---|---|---|---|---|---|---|---|---|---|---|
AD | Andorra | y | y | y | y | ||||||
AE | United Arab Emirates | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
AF | Afghanistan | y | y | ||||||||
AG | Antigua and Barbuda | y | y | ||||||||
AI | Anguilla | y | y | ||||||||
AL | Albania | y | y | y | y | y* | y | ||||
AM | Armenia | y | y | y | y | y* | y | ||||
AO | Angola | y | y | y | y | y* | y | ||||
AR | Argentina | y | y | y | y | y | y | ||||
AS | American Samoa | y | y | y | y | y | y | ||||
AT | Austria | y | y | y | y | y | y | Residency permit* | Residency permit | ||
AU | Australia | y | y | y* | y | y* | y | Keypass ID, Residency permit* | Keypass ID, Residency permit | ||
AZ | Azerbaijan | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
BA | Bosnia and Herzegovina | y | y | y | y | y* | y | ||||
BB | Barbados | y | y | y | y | ||||||
BD | Bangladesh | y | y | y | y | y* | y | ||||
BE | Belgium | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
BF | Burkina Faso | y | y | ||||||||
BG | Bulgaria | y | y | y | y | y | y | Residency permit* | Residency permit | ||
BH | Bahrain | y | y | y* | y | ||||||
BI | Burundi | y | y | ||||||||
BJ | Benin | y | y | y | y | y | y | ||||
BM | Bermuda | y | y | y | y | Voter ID | Voter ID | ||||
BN | Brunei Darussalam | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
BO | Bolivia (Plurinational State of) | y | y | y | y | y* | y | ||||
BR | Brazil | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
BS | Bahamas | y | y | y | y | Work permit* | Work permit | ||||
BT | Bhutan | y | y | ||||||||
BW | Botswana | y | y | y | y | y* | y | ||||
BY | Belarus | y | y | y | y | y | y | ||||
BZ | Belize | y | y | ||||||||
CA | Canada | y | y | 13 | 13 | 12 | 12 | Citizen certificate, Healthcare Insurance card_, Passport card_, Permanent resident card*, Tribal ID | Citizen certificate, Healthcare Insurance card, Passport card, Permanent resident card, Tribal ID | ||
CA | Canada | Alberta | y | y | y | y | |||||
CA | Canada | British Columbia | y | y | y | y | |||||
CA | Canada | Manitoba | y | y | y | y | |||||
CA | Canada | New Brunswick | y | y | y | y | |||||
CA | Canada | Newfoundland and Labrador | y | y | y | y | |||||
CA | Canada | Nova Scotia | y | y | y | y | |||||
CA | Canada | Ontario | y | y | y | y | |||||
CA | Canada | Prince Edward Island | y | y | y | y | |||||
CA | Canada | Quebec | y | y | |||||||
CA | Canada | Saskatchewan | y | y | y | y | |||||
CA | Canada | Northwest Territories | y | y | y | y | |||||
CA | Canada | Nunavut | y | y | y | y | |||||
CA | Canada | Yukon | y | y | y | y | |||||
CD | Congo (Democratic Republic of the) | y | y | Voter ID | Voter ID | ||||||
CF | Central African Republic | y | y | ||||||||
CG | Congo | y | y | y* | y | y* | y | ||||
CH | Switzerland | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
CI | Côte d’Ivoire | y | y | y* | y | y* | y | ||||
CL | Chile | y | y | y | y | y | y | ||||
CM | Cameroon | y | y | y | y | y* | y | ||||
CN | China | y | y | y | y | y* | y | ||||
CO | Colombia | y | y | y* | y | y* | y | Foreigner ID | Foreigner ID | ||
CR | Costa Rica | y | y | y | y | y* | y | ||||
CU | Cuba | y | y | y* | y | ||||||
CV | Cabo Verde | y | y | ||||||||
CW | Curaçao | y | y | y | y | y | y | ||||
CY | Cyprus | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
CZ | Czech Republic | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
DE | Germany | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
DJ | Djibouti | y | y | ||||||||
DK | Denmark | y | y | y | y | Residency permit* | Residency permit | ||||
DM | Dominica | y | y | ||||||||
DO | Dominican Republic | y | y | y* | y | y* | y | ||||
DZ | Algeria | y | y | y* | y | ||||||
EC | Ecuador | y | y | y | y | y* | y | Consular ID | Consular ID | ||
EE | Estonia | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
EG | Egypt | y | y | y | y | y* | y | ||||
ER | Eritrea | y | y | ||||||||
ES | Spain | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
ET | Ethiopia | y | y | y | y | y | y | Residency permit* | Residency permit | ||
FI | Finland | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
FJ | Fiji | y | y | y | y | ||||||
FM | Micronesia (Federated States of) | y | y | ||||||||
FO | Faroe Islands | y | y | y | y | ||||||
FR | France | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
GA | Gabon | y | y | ||||||||
GB | United Kingdom of Great Britain and Northern Ireland | y | y | y | y | y | y | Residency permit*, Voter ID | Residency permit, Voter ID | ||
GD | Grenada | y | y | ||||||||
GE | Georgia | y | y | y | y | y* | y | ||||
GG | Guernsey | y | y | y | y | y | y | ||||
GH | Ghana | y | y | y | y | y* | y | Voter ID | Voter ID | ||
GI | Gibraltar | y | y | y | y | y* | y | ||||
GL | Greenland | y | y | ||||||||
GM | Gambia | y | y | ||||||||
GN | Guinea | y | y | ||||||||
GQ | Equatorial Guinea | y | y | ||||||||
GR | Greece | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
GT | Guatemala | y | y | y* | y | y* | y | Consular ID* | Consular ID | ||
GU | Guam | y | y | y | y | y | y | ||||
GW | Guinea-Bissau | y | y | ||||||||
GY | Guyana | y | y | ||||||||
HK | Hong Kong | y | y | y | y | ||||||
HN | Honduras | y | y | y* | y | y | y | Consular ID | Consular ID | ||
HR | Croatia | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
HT | Haiti | y | y | ||||||||
HU | Hungary | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
ID | Indonesia | y | y | y | y | y | y | ||||
IE | Ireland | y | y | y | y | y* | y | Passport card_, Residency permit_ | Passport card, Residency permit | ||
IL | Israel | y | y | y | y | y* | y | ||||
IM | Isle of Man | y | y | y | y | ||||||
IN | India | y | y | y* | y | y | y | Permanent Account Number (PAN) card, Voter ID* | Permanent Account Number (PAN) card, Voter ID | ||
IQ | Iraq | y | y | y* | y | ||||||
IS | Iceland | y | y | y | y | Residency permit* | Residency permit | ||||
IT | Italy | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
JE | Jersey | y | y | y | y | ||||||
JM | Jamaica | y | y | y | y | y | y | Voter ID | Voter ID | ||
JO | Jordan | y | y | y | y | y* | y | ||||
JP | Japan | y | y | y | y | My Number card, Residency permit*, Visa | My Number card, Residency permit, Visa | ||||
KE | Kenya | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
KG | Kyrgyzstan | y | y | y | y | y* | y | ||||
KH | Cambodia | y | y | y | y | ||||||
KI | Kiribati | y | y | ||||||||
KM | Comoros | y | y | ||||||||
KN | Saint Kitts and Nevis | y | y | ||||||||
KR | Korea (Republic of) | y | y | y | y | y | y | Residency permit* | Residency permit | ||
KW | Kuwait | y | y | y* | y | y | y | ||||
KY | Cayman Islands | y | y | y | y | ||||||
KZ | Kazakhstan | y | y | y | y | y* | y | ||||
LA | Lao People’s Democratic Republic | y | y | y | y | ||||||
LB | Lebanon | y | y | y | y | y | y | ||||
LC | Saint Lucia | y | y | ||||||||
LI | Liechtenstein | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
LK | Sri Lanka | y | y | y | y | y* | y | ||||
LR | Liberia | y | y | ||||||||
LS | Lesotho | y | y | ||||||||
LT | Lithuania | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
LU | Luxembourg | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
LV | Latvia | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
LY | Libya | y | y | ||||||||
MA | Morocco | y | y | y* | y | y* | y | ||||
MC | Monaco | y | y | y* | y | Residency permit* | Residency permit | ||||
MD | Moldova (Republic of) | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
ME | Montenegro | y | y | y | y | y* | y | ||||
MF | Saint Martin (French part) | y | y | y | y | ||||||
MG | Madagascar | y | y | ||||||||
MH | Marshall Islands | y | y | ||||||||
MK | North Macedonia | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
ML | Mali | y | y | ||||||||
MM | Myanmar | y | y | y | y | y* | y | ||||
MN | Mongolia | y | y | y* | y | y* | y | ||||
MO | Macao | y | y | Residency permit* | Residency permit | ||||||
MR | Mauritania | y | y | ||||||||
MS | Montserrat | y | y | ||||||||
MT | Malta | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
MU | Mauritius | y | y | y* | y | ||||||
MV | Maldives | y | y | ||||||||
MW | Malawi | y | y | y | y | ||||||
MX | Mexico | y | y | 32 | 32 | Consular ID_, Residency permit_, Voter ID* | Consular ID, Residency permit, Voter ID | ||||
MX | Mexico | Aguascalientes | y | y | |||||||
MX | Mexico | Baja California | y | y | |||||||
MX | Mexico | Baja California Sur | y | y | |||||||
MX | Mexico | Campeche | y | y | |||||||
MX | Mexico | Chiapas | y | y | |||||||
MX | Mexico | Chihuahua | y | y | |||||||
MX | Mexico | Coahuila | y | y | |||||||
MX | Mexico | Colima | y | y | |||||||
MX | Mexico | Ciudad de México | y | y | |||||||
MX | Mexico | Durango | y | y | |||||||
MX | Mexico | Guanajuato | y | y | |||||||
MX | Mexico | Guerrero | y | y | |||||||
MX | Mexico | Hidalgo | y | y | |||||||
MX | Mexico | Jalisco | y | y | |||||||
MX | Mexico | Estado de México | y | y | |||||||
MX | Mexico | Michoacán | y | y | |||||||
MX | Mexico | Morelos | y | y | |||||||
MX | Mexico | Nayarit | y | y | |||||||
MX | Mexico | Nuevo León | y | y | |||||||
MX | Mexico | Oaxaca | y | y | |||||||
MX | Mexico | Puebla | y | y | |||||||
MX | Mexico | Querétaro | y | y | |||||||
MX | Mexico | Quintana Roo | y | y | |||||||
MX | Mexico | San Luis Potosí | y | y | |||||||
MX | Mexico | Sinaloa | y | y | |||||||
MX | Mexico | Sonora | y | y | |||||||
MX | Mexico | Tabasco | y | y | |||||||
MX | Mexico | Tamaulipas | y | y | |||||||
MX | Mexico | Tlaxcala | y | y | |||||||
MX | Mexico | Veracruz | y | y | |||||||
MX | Mexico | Yucatán | y | y | |||||||
MX | Mexico | Zacatecas | y | y | |||||||
MY | Malaysia | y | y | y | y | y* | y | ||||
MZ | Mozambique | y | y | y* | y | ||||||
NA | Namibia | y | y | y* | y | ||||||
NE | Niger | y | y | ||||||||
NG | Nigeria | y | y | y | y | y* | y | Voter ID | Voter ID | ||
NI | Nicaragua | y | y | y | y | Voter ID | Voter ID | ||||
NL | Netherlands | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
NO | Norway | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
NP | Nepal | y | y | y | y | y | y | Citizen certificate | Citizen certificate | ||
NR | Nauru | y | y | ||||||||
NZ | New Zealand | y | y | y | y | y | y | ||||
OM | Oman | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
PA | Panama | y | y | y | y | y | y | Permanent resident card | Permanent resident card | ||
PE | Peru | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
PG | Papua New Guinea | y | y | ||||||||
PH | Philippines | y | y | y | y | y* | y | Healthcare Insurance card, NBI Clearance, Overseas Foreign Worker card (OFW), Postal ID, Social Security System card, United Multi Purpose ID (UMID), Voter ID | Healthcare Insurance card, NBI Clearance, Overseas Foreign Worker card (OFW), Postal ID, Social Security System card, United Multi Purpose ID (UMID), Voter ID | ||
PK | Pakistan | y | y | y* | y | ||||||
PL | Poland | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
PR | Puerto Rico | y | y | y | y | y | y | ||||
PS | Palestine, State of | y | y | ||||||||
PT | Portugal | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
PW | Palau | y | y | ||||||||
PY | Paraguay | y | y | y | y | y* | y | ||||
QA | Qatar | y | y | y | y | y | y | Residency permit* | Residency permit | ||
RO | Romania | y | y | y | y | y | y | Residency permit* | Residency permit | ||
RS | Serbia | y | y | y | y | y* | y | ||||
RU | Russian Federation | y | y | y | y | Internal passport | Internal passport | ||||
RW | Rwanda | y | y | y | y | y | y | ||||
SA | Saudi Arabia | y | y | y | y | y | y | Residency permit* | Residency permit | ||
SB | Solomon Islands | y | y | ||||||||
SC | Seychelles | y | y | y | y | ||||||
SD | Sudan | y | y | ||||||||
SE | Sweden | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
SG | Singapore | y | y | y | y | y* | y | Long-Term pass card, Work permit | Long-Term pass card, Work permit | ||
SI | Slovenia | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
SK | Slovakia | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
SL | Sierra Leone | y | y | ||||||||
SM | San Marino | y | y | y* | y | ||||||
SN | Senegal | y | y | y | y | y | y | ||||
SO | Somalia | y | y | ||||||||
SR | Suriname | y | y | ||||||||
SS | South Sudan | y | y | ||||||||
ST | Sao Tome and Principe | y | y | ||||||||
SV | El Salvador | y | y | y* | y | y* | y | ||||
SZ | eSwatini | y | y | ||||||||
TC | Turks and Caicos Islands | y | y | ||||||||
TD | Chad | y | y | ||||||||
TG | Togo | y | y | ||||||||
TH | Thailand | y | y | y | y | y* | y | ||||
TJ | Tajikistan | y | y | ||||||||
TL | Timor-Leste | y | y | ||||||||
TM | Turkmenistan | y | y | ||||||||
TN | Tunisia | y | y | y | y | y* | y | ||||
TO | Tonga | y | y | ||||||||
TR | Turkey | y | y | y* | y | y* | y | Residency permit* | Residency permit | ||
TT | Trinidad and Tobago | y | y | y | y | y* | y | ||||
TV | Tuvalu | y | y | ||||||||
TW | Taiwan | y | y | y | y | y* | y | Healthcare Insurance card, Residency permit* | Healthcare Insurance card, Residency permit | ||
TZ | Tanzania, United Republic of | y | y | y | y | y | y | Voter ID | Voter ID | ||
UA | Ukraine | y | y | y | y | Passport card_, Residency permit_ | Passport card, Residency permit | ||||
UG | Uganda | y | y | y | y | y | y | ||||
US | United States of America | y | y | 51 | 51 | 51 | 51 | Passport card_, Permanent resident card_, Travel Document, Visa, Work permit* | Passport card, Permanent resident card, Travel Document, Visa, Work permit | ||
US | United States of America | Alabama | y | y | y | y | |||||
US | United States of America | Alaska | y | y | y | y | |||||
US | United States of America | Arizona | y | y | y | y | |||||
US | United States of America | Arkansas | y | y | y | y | |||||
US | United States of America | California | y | y | y | y | |||||
US | United States of America | Colorado | y | y | y | y | |||||
US | United States of America | Connecticut | y | y | y | y | |||||
US | United States of America | District of Columbia | y | y | y | y | |||||
US | United States of America | Delaware | y | y | y | y | |||||
US | United States of America | Florida | y | y | y | y | |||||
US | United States of America | Georgia | y | y | y | y | |||||
US | United States of America | Hawaii | y | y | y | y | |||||
US | United States of America | Idaho | y | y | y | y | |||||
US | United States of America | Illinois | y | y | y | y | |||||
US | United States of America | Indiana | y | y | y | y | |||||
US | United States of America | Iowa | y | y | y | y | |||||
US | United States of America | Kansas | y | y | y | y | |||||
US | United States of America | Kentucky | y | y | y | y | |||||
US | United States of America | Louisiana | y | y | y | y | |||||
US | United States of America | Maine | y | y | y | y | |||||
US | United States of America | Maryland | y | y | y | y | |||||
US | United States of America | Massachusetts | y | y | y | y | |||||
US | United States of America | Michigan | y | y | y | y | |||||
US | United States of America | Minnesota | y | y | y | y | |||||
US | United States of America | Mississippi | y | y | y | y | |||||
US | United States of America | Missouri | y | y | y | y | |||||
US | United States of America | Montana | y | y | y | y | |||||
US | United States of America | Nebraska | y | y | y | y | |||||
US | United States of America | Nevada | y | y | y | y | |||||
US | United States of America | New Hampshire | y | y | y | y | |||||
US | United States of America | New Jersey | y | y | y | y | |||||
US | United States of America | New Mexico | y | y | y | y | |||||
US | United States of America | New York | y | y | y | y | |||||
US | United States of America | North Carolina | y | y | y | y | |||||
US | United States of America | North Dakota | y | y | y | y | |||||
US | United States of America | Ohio | y | y | y | y | |||||
US | United States of America | Oklahoma | y | y | y | y | |||||
US | United States of America | Oregon | y | y | y | y | |||||
US | United States of America | Pennsylvania | y | y | y | y | |||||
US | United States of America | Rhode Island | y | y | y | y | |||||
US | United States of America | South Carolina | y | y | y | y | |||||
US | United States of America | South Dakota | y | y | y | y | |||||
US | United States of America | Tennessee | y | y | y | y | |||||
US | United States of America | Texas | y | y | y | y | |||||
US | United States of America | Utah | y | y | y | y | |||||
US | United States of America | Vermont | y | y | y | y | |||||
US | United States of America | Virginia | y | y | y | y | |||||
US | United States of America | Washington | y | y | y | y | |||||
US | United States of America | West Virginia | y | y | y | y | |||||
US | United States of America | Wisconsin | y | y | y | y | |||||
US | United States of America | Wyoming | y | y | y | y | |||||
UY | Uruguay | y | y | y | y | y* | y | ||||
UZ | Uzbekistan | y | y | y | y | y | y | ||||
VC | Saint Vincent and the Grenadines | y | y | ||||||||
VE | Venezuela (Bolivarian Republic of) | y | y | y | y | y | y | ||||
VI | Virgin Islands (U.S.) | y | y | y | y | y | y | ||||
VN | Viet Nam | y | y | y | y | y | y | ||||
VU | Vanuatu | y | y | ||||||||
WS | Samoa | y | y | ||||||||
XK | Kosovo | y | y | y | y | y* | y | Residency permit* | Residency permit | ||
YE | Yemen | y | y | y | y | ||||||
ZA | South Africa | y | y | y | y | y | y | ||||
ZM | Zambia | y | y | ||||||||
ZW | Zimbabwe | y | y | y | y | y | y |