v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
simulation

Simulate requirement submission

Simulates providing everything needed for a particular KYC requirement. This can be used in place of going through a hosted journey on the browser.

{% admonition type="info" %} This functionality only works for the following requirements: TRANSFER_PURPOSE, ID_DOCUMENT_WITH_LIVENESS, SOURCE_OF_FUNDS, and any other that has the ___ delimiter in them. {% /admonition %}

post/v2/simulation/profiles/{profileId}/kyc-reviews/{kycReviewId}/requirements/submit

Path parameters

profileIdinteger required

The profile ID.

kycReviewIdstring uuid required

The ID of the existing KYC review.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Request body

requirementstring

Requirement to simulate hosted journey for.

Response

Requirement submitted successfully. No content returned.