Skip to main content
POST
Create customer organization

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Body

application/json
accountType
enum<string> | null

Whether this org is an individual or a company:

  • personal: an individual customer completing KYC. Send userInfo.
  • business: a company completing KYB. userInfo is rejected.

Optional today and defaults to personal. It will become required, so send it explicitly now.

Available options:
personal,
business
Example:

"personal"

displayName
string | null

The organization's display name: the friendly label shown in UIs and API responses. For a business org completing KYB, the legal entity name is captured separately via legalName.

id
string<uuid> | null
userInfo
null | object

Optional info about the end user. Required eventually for personal orgs. Rejected on business orgs (those don't have a single end user).

country
string | null

ISO 3166-1 alpha-2 country code (e.g. MX). Business orgs only; rejected on personal orgs. When provided, Etherfuse generates the KYB onboarding at creation, seeding the company entity with this country so the user lands straight in KYB. Omit it and the user is prompted for their country when they begin KYB.

Example:

"MX"

Legal entity name for the KYB company entity (e.g. the incorporated name on the company's registry documents). Pass it together with country when generating the KYB onboarding at creation; rejected without country. Independent of displayName: renaming the org does not change the legal name, and vice versa.

Example:

"Acme Corporation S.A. de C.V."

Response

The new organization.

id
string<uuid>
required
displayName
string
required
accountType
enum<string>
required

personal: an individual who completes KYC. business: a company that completes KYB.

Available options:
personal,
business
approvedAt
string<date-time> | null
required

When the organization's KYC or KYB was approved. Null until then.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required