Skip to content

Update KYC Review to get a Hosted KYC link

Request

Updates the KYC Review with a redirect URL.

Returns the KYC Review object with a link field containing a URL where the end customer needs to be directed in order to complete the Hosted KYC flow. The link is short-lived and single-use and valid for 5 minutes. Use the expiresAt field in the response to determine the exact expiry time. To regenerate the link, call this endpoint again.

Once the Hosted KYC flow is completed by the end customer, they will be redirected to the redirectUrl provided in this API call. During the redirection, the redirectUrl will be appended with query parameters: status=success, status=failed, or status=closed.

Security
UserToken
Path
profileIdinteger, (int64)required

The profile ID.

kycReviewIdstring, (uuid)required

The KYC Review ID.

Headers
X-External-Correlation-Idstring, (uuid), <= 36 characters

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

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479
Bodyapplication/jsonrequired
redirectUrlstringrequired

URL where the user will be redirected at the end of the flow. Can contain query params and path fragments. It has to be a valid URL as per RFC 2396.

Example:"https://example.com"
curl -i -X PATCH \
  'https://api.wise.com/v1/profiles/{profileId}/kyc-reviews/{kycReviewId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479' \
  -d '{
    "redirectUrl": "https://example.com"
  }'

Responses

Returns the updated KYC Review object.

Headers
X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"
x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"
Bodyapplication/json
idstring, (uuid)

Unique identifier for a KYC Review resource, generated by Wise.

Example:"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8"
statusstring

Aggregated state of the underlying requirement set. Any of the states below could move into any other state.

Enum:"NEW""PASSED""PASSED_WITH_REQUIREMENTS""WAITING_CUSTOMER_INPUT""PROCESSING"
Example:"WAITING_CUSTOMER_INPUT"
createdAtstring, (date-time)

Timestamp marking the creation of the KYC Review.

Example:"2024-09-03T16:22:02.257725"
updatedAtstring, (date-time)

Timestamp marking the last update of the KYC Review.

Example:"2024-09-03T16:29:41.147522"
requiredBystring or null, (date-time)

Timestamp by which the underlying requirement set needs to be verified to not block the customer. Only relevant if the status is PASSED_WITH_REQUIREMENTS.

Example:"2024-09-03T16:22:02.257725"
triggerReferencesArray of objects

List of trigger reference objects.

redirectUrlstring or null

URL where the user will be redirected at the end of the flow. Can contain query params and path fragments. It has to be a valid URL as per RFC 2396. Provided by the caller in the Update redirect URL call.

Example:"https://example.com"
requirementsArray of items or null

Nested list of KYC Requirement objects in [[Requirement]] format, where each inner list represents a combination of possible requirements to be provided. To fulfil the whole KYC Review, at least one item from each inner list should be provided.

For example, if the requirements are [[a, b], [c, d]] then it should be read as (a or b) and (c or d).

Response
{
  "id": "46e1a5c4-4a9b-4563-39d3-18174d3ac0f8",
  "status": "WAITING_CUSTOMER_INPUT",
  "link": {
    "value": "https://wise-sandbox.com/embedded-flows/verification?token=d7332edb-25bf-41af-a4e9-09f5efe39ded&checkId=3120073",
    "expiresAt": "2024-09-03T16:29:41.203225146"
  },
  "createdAt": "2024-09-03T16:22:02.257725",
  "updatedAt": "2024-09-03T16:29:41.147522",
  "requiredBy": "2024-09-03T16:22:02.257725",
  "triggerReferences": [
    {
      "type": "QUOTE",
      "triggerData": { … }
    }
  ],
  "redirectUrl": "https://example.com",
  "requirements": [
    [
      { … }
    ]
  ]
}