v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Organisations
KYC
Organisations

Verification flow

Calling this endpoint with a valid organisation ID will return a url to redirect the customer to that allows a user to manage the full verification process, your customer can return to the flow at any point through an additional request to this endpoint.

You must provide returnUrl in the request body which will be used to redirect the user back to your system on completion of the current process.

The verification process is asynchronous - a customer can supply information then return to your application while other checks are conducted.

If the organisation has already completed the verification process, this endpoint will return a 204 No Content response. This is not a final state and a 200 with a URL may be returned at a later date.

post/organisations/{organisationId}/verify

Path parameters

organisationIdstring uuid required

The unique Crezco ID for an organisation

Headers

Crezco-Versionstring

The requested API version

Request body

returnUrlstring required

Url that Crezco will redirect the customer to after completing verification in the Crezco system.

Response

OK

urlstring

Url hosted by Crezco that you should redirect the customer to in order to complete the verification process.