Get Onboarding Status

GET 
/api/partner/v1/onboarding/:ref

Returns the full status for one merchant onboarding, identified by the ref you chose at creation. Includes the base fields (id, ref, channel, status), the hosted hand-off (next_action — always an object; next_action.url may be null), and any third-party invitations (invited, PII-free). Lookup is scoped to your partner channels: an unknown ref returns 404. Requires scope onboarding:read.

Request

Responses

200

Onboarding status with hand-off and invitations.

401

Missing, malformed, revoked, or unusable partner API key.

403

The partner key lacks the onboarding:read scope.

404

No onboarding with this ref exists within the partner's channels.