Skip to main content
POST
Create Entity

Authorizations

Authorization
string
header
required

API key prefixed with sk_.

Body

application/json
email
string<email>
required

Email address for the Entity.

type
enum<string>
required

The type of Entity.

Available options:
individual,
business
fullName
string

Full name of the individual. Required when type is individual.

businessName
string

Name of the business. Required when type is business.

Response

Entity created.

id
string
Example:

"ent_01JA1B2C3D4E5F6G7H8J9K0L"

email
string<email>
type
enum<string>
Available options:
individual,
business
kycStatus
string
Example:

"not_started"

tosStatus
string
Example:

"not_started"

Share this link with the Entity to begin identity verification.

Example:

"https://verify.otim.com/kyc/abc123"

Share this link with the Entity to accept terms of service.

Example:

"https://verify.otim.com/tos/abc123"

createdAt
string<date-time>