Submit Entity

Submits an entity for approval

post/v3/entity/{id}/submit

Request

Base URL
https://service-sandbox.tazapay.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/tazapay/apis/sandbox/docs/v3/entity/:id/submit/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Tazapay unique ID of the entity

Request body

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

Type of the entity

registration_numberstring required

Business Registration Number

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' required

The entity's relationship with you

purpose_of_usestring[] required

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.

Changes

No recorded changes to this operation across all 1 revision of this API.