Skip to main content
POST

Authorizations

Authorization
string
header
required

Path Parameters

entity_id
string
required

Unique identifier for the entity, such as ent_8anBwgZktbZH6ydyHa6Tm0eM.

Body

application/json
type
enum<string>
required

Type of onboarding to create: account_holder or settlement_recipient.

Available options:
account_holder,
settlement_recipient
data
object
required

Onboarding answers, grouped by step. Mexican account holders provide company_information, legal_representatives, transactional_profile, and shareholders. Chilean account holders provide company_basics, company_information, senior_management, legal_representatives, shareholders, transactional_profile, and plaft. position is optional for Chilean representatives. Each Chilean shareholder also includes address, fiscal_address, and effective_controller. company_basics.incorporation_type (one_day_company or traditional) determines the company document slots, and plaft.uaf_obligated decides whether you must upload uaf_registration_certificate and plaft_manual_and_policies. Chilean companies onboarding as settlement recipients must also send company_information.activities_start_date, the date the company started activities before the Chilean tax authority, as an ISO 8601 date such as 2018-05-02. For Mexican account_holder onboardings, transactional_profile.account_purpose is required. Allowed values: own_sales_collection, collection_and_dispersion, marketplace, psp_aggregator, third_party_dispersion, betting_gaming, other. transactional_profile.account_purpose_details is required when account_purpose is other; provide a description of the intended account use.

Response

The API starts the onboarding process from the provided data and returns the created onboarding.

id
string
required

Unique identifier of the onboarding.

Example:

"onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K"

object
any
required

Type of the object. Always onboarding.

data
object
required

Reviewed answers, grouped by step. The fields depend on the onboarding type and the entity's country. Chilean account holders include company_basics, company_information, senior_management, transactional_profile, and plaft. Mexican account holders include company_information and transactional_profile, with declaration_accepted set to true and incorporation_date returned as an ISO 8601 datetime in UTC.

Example:
documents
object[]
required

Document slots for the onboarding, with their upload status. A slot that accepts more than one file appears once per uploaded file, repeating its slot_key. A slot with no files appears once, with status set to missing. Chilean account holders always list uaf_registration_certificate and plaft_manual_and_policies, but you upload them only if plaft.uaf_obligated is true.

entity_id
string | null
required

Identifier of the entity this onboarding belongs to. null if not associated with an entity.

Example:

"ent_8anBwgZktbZH6ydyHa6Tm0eM"

Legal representatives declared for the entity.

reviewed_at
string<date-time> | null
required

ISO 8601 datetime, in UTC, of when the onboarding was reviewed. null until it is reviewed.

Example:

"2026-01-16T09:00:00Z"

shareholders
object[]
required

Shareholders declared for the entity.

source
enum<string>
required

Channel the onboarding is being completed through. One of api or dashboard.

Available options:
api,
dashboard
Example:

"api"

status
enum<string>
required

Current status of the onboarding. One of pending, in_progress, submitted, approved, rejected or cancelled.

Available options:
pending,
in_progress,
submitted,
approved,
rejected,
cancelled
Example:

"pending"

submittable
boolean
required

Whether the onboarding has every required field and document completed and can be submitted for review.

Example:

false

submitted_at
string<date-time> | null
required

ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. null until it is submitted.

Example:

"2026-01-15T14:30:00Z"

type
enum<string>
required

Type of the onboarding: account_holder or settlement_recipient.

Available options:
account_holder,
settlement_recipient
Example:

"account_holder"