Skip to main content
Use the /kyc endpoint to perform Know Your Customer (KYC) verification tasks for your account holders. This endpoint can only be used to perform KYC verification for individuals or businesses in the United States. For more information about KYC verification, see About KYC Verification. For more information about account holders, see About Account Holders.

Perform KYC verification

Action: POST
Endpoint: /kyc
Use this endpoint to verify the identity of an account holder in the United States, either a user or a business. You can perform KYC verification on an account holder, provided the following are true:
  • The KYC status of the account holder is UNVERIFIED, LIMITED, or ACTIVE.
  • The account holder has not been submitted for KYC verification more than twice.

Required fields

In order to perform KYC verification, the user or business resource on which you perform the check must have the following fields configured with valid values:

Valid state, provincial, territorial, and federal abbreviations

The following list includes all valid two-letter abbreviations for US states, territories, and military (APO/FPO/DPO) addresses. It also includes two-letter abbreviations for Canadian provinces and territories and three-letter abbreviations for supported countries. State, provincial, territorial, and federal abbreviations are case sensitive, and must be in uppercase as they appear in this list:
  • AL: Alabama
  • AK: Alaska
  • AB: Alberta
  • AS: American Samoa
  • AZ: Arizona
  • AR: Arkansas
  • AE: Armed Forces
  • AA: Armed Forces Americas
  • AP: Armed Forces Pacific
  • BC: British Columbia
  • CA: California
  • CAN: Canada
  • CO: Colorado
  • CT: Connecticut
  • DE: Delaware
  • DC: District of Columbia
  • FL: Florida
  • GA: Georgia
  • GU: Guam
  • HI: Hawaii
  • ID: Idaho
  • IL: Illinois
  • IN: Indiana
  • IA: Iowa
  • KS: Kansas
  • KY: Kentucky
  • LA: Louisiana
  • ME: Maine
  • MB: Manitoba
  • MD: Maryland
  • MA: Massachusetts
  • MI: Michigan
  • MN: Minnesota
  • MS: Mississippi
  • MO: Missouri
  • MT: Montana
  • NE: Nebraska
  • NV: Nevada
  • NB: New Brunswick
  • NH: New Hampshire
  • NJ: New Jersey
  • NM: New Mexico
  • NY: New York
  • NF: Newfoundland
  • NC: North Carolina
  • ND: North Dakota
  • NT: Northwest Territories
  • NS: Nova Scotia
  • NU: Nunavut
  • OH: Ohio
  • OK: Oklahoma
  • ON: Ontario
  • OR: Oregon
  • PA: Pennsylvania
  • PE: Prince Edward Island
  • PR: Puerto Rico
  • QC: Quebec
  • RI: Rhode Island
  • SK: Saskatchewan
  • SC: South Carolina
  • SD: South Dakota
  • TN: Tennessee
  • TX: Texas
  • USA: United States of America
  • UT: Utah
  • VT: Vermont
  • VI: Virgin Islands
  • VA: Virginia
  • WA: Washington
  • WV: West Virginia
  • WI: Wisconsin
  • WY: Wyoming
  • YT: Yukon Territory

Request body

Sample request body

Sample request body for a user
JSON
Sample request body for a business
JSON

Response body

Sample response body

Sample response body for a user
JSON
Sample response body for a business
JSON

List KYC results for a business

Action: GET
Endpoint: /kyc/business/{business_token}
Use this endpoint to retrieve all KYC verification results for a business. This endpoint supports pagination.

Business KYC outcome reasons (business response)

The following tables describe KYC outcome reasons potentially returned in the outcome_reasons field of the business result response object when a business is in a pending or failure state. Where possible, they also describe acceptable documents that your customers can submit to resolve pending outcomes.

Outcome reasons for the business

These outcome reasons pertain to the business organization itself.

Outcome reasons for individuals associated with a business

These outcome reasons pertain to individuals associated with a business: proprietors, business officers, and beneficial owners.

URL path parameters

URL query parameters

Response body

Sample response body

JSON

List KYC results for a user

Action: GET
Endpoint: /kyc/user/{user_token}
Use this endpoint to retrieve all KYC results for a user. This endpoint supports pagination.

User KYC failure codes

The following table lists KYC failure codes potentially returned in the response when a user does not pass verification. It also includes a list of acceptable documents that your customers can submit to resolve failures.

URL path parameters

URL query parameters

Response body

Sample response body

JSON

Retrieve KYC result

Action: GET
Endpoint: /kyc/{token}
Use this endpoint to retrieve a specific KYC result.

URL path parameters

Response body

Sample response body

JSON