Update kyb

With this request, you can update the KYB information for an existing onboarded business. You will need to provide all KYB-related details using this API and ensure that the business's KYB status is either null or Failed.

📘
Authentication Route
This route is secured with processor and vendor token authentication.

Endpoint

/3p/api/v2/users/{uuid}/kyb

Example

{
  "first_name": "Jack",
  "last_name": "Jones",
  "email": "[email protected]",
  "phone": "2457856494",
  "business": {
    "name": "Jack Inc.",
    "tin": "958455211",
    "trading_name": "Jack Corp.",
    "entity_type": "Sole Trader",
    "incorporation_date": "2024-03-01",
    "incorporation_state": "CO",
    "address_type": "Registered",
    "address": {
      "line_1": "10554",
      "city": "spaces",
      "state": "CA",
      "zip": "80127"
    }
  }
}

Body Parameters

Fields	Type	Is Required	Description
first_name	string	Yes	Max characters: 56 Only accepts letters (a-z, A-Z, À-ÿ), numbers (0-9), hyphens (-), periods (.), apostrophes ('), and spaces.
last_name	string	Yes	Max characters: 56 Only accepts letters (a-z, A-Z, À-ÿ), numbers (0-9), hyphens (-), periods (.), apostrophes ('), and spaces.
email	string	Yes
phone	string	Yes	without prefix +1 for eg. 2092370450
business.name	string	Yes	Legal name of the business Max characters: 64 Only accepts letters (a-z, A-Z), numbers (0-9), ampersand(&), hyphens (-), periods (.), apostrophes ('), comma(,), plus (+) and spaces.
business.tin	string	Yes	must consist of 9 digit without any special character
business.trading_name	string	Yes	Trading name of the business
business.entity_type	string	Yes	Business entity type. For eg. Sole Trader, Limited Company etc.
business.incorporation_date	date:Y-m-d	Yes	Date when the company was incorporated
business.incorporation_state	string(2)	Yes	State where the company was incorporated (US only)
business.industry	string	No	Nature of business
business.industry_classification.code_type	string		Type of industry classification code. eg. SIC etc. Required if `industry_classification` exists
business.industry_classification.codes	array string		Industry classification codes Required if `industry_classification` exists
business.industry_classification.description	string		Description of the industry classification code Required if `industry_classification` exists
business.source_of_wealth	string	No	Source of wealth of the company
business.source_of_funds	string	No	Source of initial deposit of the company
business.first_transaction_completed_at	datetime:Y-m-d H:i:s	No	Original timestamp of when the person completed their first transaction
business.product_type	string	No
business.registered_as_inactive	boolean	No
business.address_type	string	Yes	Type of address. For eg. Registered, Trading, Legal etc.
business.address.line_1	string	Yes
business.address.city	string	Yes
business.address.state	string(2)	Yes
business.address.zip	string	Yes	must consist of 5 digit without any special character

Response

{
    "status": true,
    "message": "The business KYB has been updated.",
    "data": null,
    "errors": null,
    "error_code": null
}

📘Authentication Route

Endpoint

Example

Body Parameters

Response

📘
Authentication Route