Docs › API reference › Identity verification

Complete enrolment

Notifies the API that the session has ended. The endpoint requires the JWT access token in a header.

POSThttps://api.screenlyyid.com/api/v1/enrolment/complete

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key
`x-correlation-id`	string (uuid)	Yes	Correlation ID for this customer check
`x-access-token`	string	Yes	Provider access token

Responses#

Status	Description
`200`	Successful response

Response body (200)#

Field	Type	Required	Description
`CustomerReturnUrl`	string	No

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/enrolment/complete' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'x-access-token: YOUR_ACCESS_TOKEN'

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/enrolment/complete",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID",
      "x-access-token": "YOUR_ACCESS_TOKEN"
    }
  }
);

const result = await response.json();

import requests

response = requests.post(
    'https://api.screenlyyid.com/api/v1/enrolment/complete',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID",
        "x-access-token": "YOUR_ACCESS_TOKEN"
    }
)
result = response.json()

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
client.DefaultRequestHeaders.Add("x-access-token", "YOUR_ACCESS_TOKEN");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/enrolment/complete", null);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();