Prefill Applicant Identity

PATCH 
/api/partner/v1/onboarding/:ref/identity

Prefills the identity data of the main applicant (a natural person or a sole trader): national id number, identity document, residential address, place of birth and citizenships. It only stores data - the identity verification itself and the statutory declarations (PEP, acting on own behalf) are always completed by the merchant in the hosted flow. For a multi-person company the representative's identity is handled in the hosted flow and this segment returns 422. Requires scope onboarding:write.

Request

Responses

200

Segment saved. Returns the draft reference with its current public status.

401

Missing, invalid or revoked partner key.

403

Partner key lacks the onboarding:write scope.

404

Unknown ref within your channels.

409

Account already active - onboarding data is no longer editable.

422

Validation failed, or the applicant is a multi-person company representative (handled in the hosted flow).