Skip to main content
PATCH
/
kyb
/
customers
Create or update KYB customer
curl --request PATCH \
  --url http://localhost:4000/v1/kyb/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "business",
  "email": "[email protected]",
  "business_legal_name": "Acme Corporation LLC",
  "business_type": "llc",
  "primary_website": "https://acme.com",
  "is_dao": false,
  "registered_address": {
    "street_line_1": "123 Main St",
    "city": "San Francisco",
    "country": "USA",
    "postal_code": "94102"
  },
  "physical_address": {
    "street_line_1": "123 Main St",
    "city": "San Francisco",
    "country": "USA",
    "postal_code": "94102"
  },
  "endorsements": [
    "base",
    "spei"
  ],
  "business_industry": [
    "541511"
  ],
  "operates_in_prohibited_countries": false,
  "currency": "usd",
  "own_bank_account": true,
  "third_party_funds": false,
  "third_party_trade": false,
  "business_tax_id_type": "rfc",
  "business_tax_id_number": "VPF200101ABC",
  "business_tax_id_country": "MEX",
  "associated_persons": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "residential_address": {
        "street_line_1": "123 Main St",
        "city": "San Francisco",
        "country": "USA",
        "postal_code": "94102"
      },
      "birth_date": "1990-01-15",
      "has_ownership": true,
      "has_control": true,
      "is_signer": true,
      "identifying_information": [
        {
          "type": "rfc",
          "issuing_country": "MEX",
          "number": "XAXX010101000",
          "description": "<string>",
          "expiration": "2030-12-31",
          "image_front": "<string>",
          "image_back": "<string>"
        }
      ],
      "middle_name": "Michael",
      "phone": "+12223334444",
      "is_director": false,
      "title": "CEO",
      "ownership_percentage": 75
    }
  ],
  "documents": [
    {
      "purpose": "business_formation",
      "file": "https://xyz.supabase.co/storage/v1/object/public/docs/formation.pdf"
    }
  ]
}
'

Body

application/json
​
type
enum<string>
required

Type of the customer (individual vs. business).

Available options:
individual,
business
Example:

"business"

​
email
string
required

The business's primary email address.

Required string length: 1 - 1024
Example:

"[email protected]"

​
business_legal_name
string
required

The official registered name of the business as documented with government authorities.

Required string length: 1 - 1024
Example:

"Acme Corporation LLC"

​
business_type
enum<string>

How the business is legally registered.

Available options:
cooperative,
corporation,
llc,
other,
partnership,
sole_prop,
trust
Example:

"llc"

​
primary_website
string

The business's primary website/web presence. A document with purpose 'proof_of_nature_of_business' is required if this is not provided.

Required string length: 1 - 1024
Example:

"https://acme.com"

​
is_dao
boolean

Whether the business is a DAO (Decentralized Autonomous Organization).

Example:

false

​
registered_address
object

The official registered address of the business.

​
physical_address
object

Physical address.

​
endorsements
enum<string>[]

List of endorsements to request for this customer. If omitted, we'll attempt to grant base and sepa.

Available options:
base,
cards,
faster_payments,
pix,
sepa,
spei
Example:
["base", "spei"]
​
business_industry
string[]

The industry in which this business operates.

Example:
["541511"]
​
operates_in_prohibited_countries
boolean

Does the business operate in any prohibited countries? Required for high risk customers.

Example:

false

​
currency
string

The currency used by the business.

Example:

"usd"

​
own_bank_account
boolean

Does the business have its own bank account?

Example:

true

​
third_party_funds
boolean

Does the business receive third party funds?

Example:

false

​
third_party_trade
boolean

Does the business trade with third parties?

Example:

false

​
business_tax_id_type
string

Type of business tax identification document (e.g. rfc, ein, nif, etc.).

Example:

"rfc"

​
business_tax_id_number
string

The business tax identification number.

Example:

"VPF200101ABC"

​
business_tax_id_country
string

ISO 3166-1 alpha-3 country code that issued the tax ID.

Example:

"MEX"

​
associated_persons
object[]

List of notable people associated with the business such as UBOs.

​
documents
object[]

Business-level documents.

Response

KYB customer saved successfully