Sign in

v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Create Entity

Create a sub-entity for your account

post/v3/entity

Request body

namestring required

Name of the entity

type'sole_proprietorship' | 'company' | 'non_profit' | 'government_entity' | 'individual' required

Type of the entity

emailstring

Email of the entity

descriptionstring

A short description of the business

tax_idstring

Tax ID of the entity

verticalstring

Industry Vertical

websitestring

Entity website

registration_numberstring

Business Registration Number

registration_datestring

Business Registration Date, Format DD-MM-YYYY

submitboolean

true or false, default is false

statement_descriptorstring

Statement Descriptor for the entity

reference_idstring

Merchant's internal reference ID for the entity

metadatastring json

Set of key-value pairs to attach to the entity

relationship'customer' | 'vendor' | 'fourth_party' | 'other'

The entity's relationship with you

purpose_of_usestring[]

The capabilities the entity intends to use. Possible values - collect, payout. In case you only want to add global collection account on behalf of the entity, pass collect. If you want to only make payouts on behalf of the entity, use payout. In case you want to do both, pass ["collect","payout"]

onboarding_package_urlstring

Link to the complete onboarding package for the entity

on_behalf_ofstring

ID of the entity this entity is created on behalf of

Response

200

statusstring

Indicates the result of the API call.

messagestring

Optional message providing context or additional information about the response. Can be empty.

Example response

{
  "data": {
    "purpose_of_use": [
      "payout"
    ]
  }
}