FOfourthline
Identity Verification

Reset document by clientId

Use this endpoint to clear a client’s ID document data from their profile so they can re-start an Identity Verification workflow with the same document, using the clientId. <br /><br /><img src="https://files.readme.io/310d4d3-Inline_Caution.svg" align="left" alt="Important" /> Important: Before using this endpoint, see the <a href="https://docs.fourthline.com/docs/idv-integration#duplicated-id-document-check">integration guide</a>.

put/whitelisting/client/{clientId}

Request

  • Base URL
    https://api.ext-sandbox.fourthline.com
  • URL
    https://api.ext-sandbox.fourthline.com/whitelisting/client/{clientId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Path parameters

clientIdstring required

Our unique identifier for the client, returned in the Create workflow response. Whether clientData is required depends on your configuration and integration method. Contact your delivery manager to confirm the fields required for your setup. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Headers

Content-Typestring
Authorizationstring required

The access_token returned in your most recent Create access token response.

Response

Document reset completed

clientstring

Our unique identifier for the client, returned in your first Create workflow request for this client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

statusstring

The status of the reset request.

messagestring

More information about the reset request.

Changes

No recorded changes to this operation across all 2 revisions of this API.