Reuse a verified KYC Profile

Call as the recipient account to validate and copy donor data into a recipient Profile,
bind it to the recipient Level, and consume the token. Successful reuse is billable to the recipient.
Returns a Profile result synchronously; it does not create a verification Application.

Provide a stable externalUserId to update the corresponding visible recipient Profile,
or create it if none exists. Omitting it generates a new identifier. Existing Profile data
is updated as follows: available donor fixed information replaces its non-address fields;
when Document is enabled, available verified information replaces its non-address fields,
copied DOC records replace records of the same type, and addresses are added with new IDs.
When Face is enabled, the copied SELFIE replaces existing SELFIE records.
Other document types and fields not written by reuse remain unchanged.
Null non-address fields in a copied information block clear the corresponding recipient fields.
Addresses shown inside information blocks follow the separate address rule: Document reuse
adds addresses and retains existing ones; Face-only reuse leaves all recipient addresses unchanged.

New and INIT recipient Profiles become ACTIVE. Existing ACTIVE Profiles remain ACTIVE;
existing INACTIVE Profiles remain INACTIVE. Check the returned status; reuse does not
reactivate an INACTIVE Profile. Preview does not check the destination Profile's write outcome.

A Document Level requires and copies identity documents and copies available verified information
and addresses. A Face Level requires and copies SELFIE records. A Level with both requires both.
Available donor fixed information is copied in either case. A new Face-only Profile may have no info.

A consumed token returns invalid_share_token on subsequent calls, rather than replaying the
original response. Avoid concurrent reuse calls for the same token. After a timeout or server
error, check the recipient Profile before retrying; the Profile may already have been updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

Non-blank sharing token issued for the authenticated recipient account.

string
required
length ≥ 1

Non-blank recipient Level ID. Must belong to the recipient, require Document and/or Face, and contain no AML step.

string | null

Recipient-side user identifier. Reuse updates the visible Profile with this identifier,
or creates one if none exists. Omit, pass null, or pass a blank value to generate an identifier.
Use a stable value to locate the resulting Profile. This is not a request replay guarantee.
Preview accepts this field but does not create, reserve, or validate the target Profile.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json