Start a seller/profile onboarding

post

https://{baseUrl}{}/v1/marketplaces/{marketplaceId}/onboarding

Creates the onboarding and returns 201 Created. A replay of the same
X-Idempotency-Key returns the same onboarding instead of creating a duplicate. The
request is acknowledged synchronously; the onboarding progresses asynchronously from there.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

marketplaceId

uuid

required

Identifier of the caller's marketplace (tenant scoping).

Body Params

type

string

enum

required

Allowed:

name

string

required

string

required

A non-blank e-mail.

national_registration

string

required

CPF (individual) or CNPJ (business), digits.

birth_date

date

required

YYYY-MM-DD, not in the future.

mothers_name

string | null

pep

boolean | null

mcc

string

required

Merchant category code, exactly 4 digits.

external_bank_account

object

revenue

double | null

cbo

string | null

legal_name

string | null

cnae

string | null

legal_nature

string | null

phone

object

required

address

object

required

partner

object

external_reference_id

uuid | null

Caller-supplied correlation id; must be a UUID when present.

Headers

X-Idempotency-Key

string

required

length between 1 and 255

Idempotency key. Required on creation paths; a request without it is rejected with 400.
Reusing a key with a different payload is rejected with 422.

Responses

201Onboarding created. Location points at the created resource.

400400. Malformed body, a field that failed local validation, a missing X-Idempotency-Key header, an unknown field, or a rejected field combination. Codes include INVALID_REQUEST and INVALID_PARAMETER.