Skip to main content
POST
Onboard the authenticated client to a project

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Authorization
string
header
required

The signed-in person's Cognito access token, issued to this application's app client. Sent with the API key on the /clients/me and /suppliers/me routes.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

Body

application/json
firstName
string | null

The client's first name as your checkout collected it, at most 80 characters after trimming. Overwrites the stored first name; blank or null means not provided.

Example:

"Emma"

lastName
string | null

The client's last name as your checkout collected it, at most 80 characters after trimming. Overwrites the stored last name; blank or null means not provided.

Example:

"Bishop"

phone
string | null

Phone number. Accepts E.164 or a national NANP number; stored as E.164 (e.g. +14165550134).

Example:

"+14165550134"

Response

Client already onboarded

data
object
required