Docs › Authentication › Authentication

Create instance

Creates a correlation ID, which you pass in the x-correlation-id header on every later call, alongside your API key, until the sequence is finished. Think of it as a session token: use it for one set of API calls for a single customer.

The request also defines which ScreenlyyID products the session can access. Put idv, aml, eidv1 and eidv2 in GlobalScreening, and adv, emv, phv, ipv and bin in CustomerIntelligence. The products must be activated on your account. See product codes.

For identity verification the response also includes a webEnrolmentUrl you can load in a WebView. See Mobile app.

POSThttps://api.screenlyyid.com/api/v1/instance/create

Headers#

Name	Type	Required	Description
`x-api-key`	string	Yes	Your ScreenlyyID API key

Request body#

Field	Type	Required
`FirstName`	string	No
`LastName`	string	No
`ClientLookupId`	string (uuid)	No
`RedirectUrl`	string	No
`GlobalScreening`	array of string	No
`CustomerIntelligence`	array of string	No

Responses#

Status	Description
`200`	Successful response
`400`	Bad request
`401`	Unauthorized

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/instance/create' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "FirstName": "Jane",
  "LastName": "Citizen",
  "ClientLookupId": "00000000-0000-0000-0000-000000000000",
  "RedirectUrl": "https://example.com/done",
  "GlobalScreening": [
    "idv"
  ],
  "CustomerIntelligence": [
    "emv"
  ]
}'

const body = {
  "FirstName": "Jane",
  "LastName": "Citizen",
  "ClientLookupId": "00000000-0000-0000-0000-000000000000",
  "RedirectUrl": "https://example.com/done",
  "GlobalScreening": [
    "idv"
  ],
  "CustomerIntelligence": [
    "emv"
  ]
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/instance/create",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    "body": JSON.stringify(body)
  }
);

const result = await response.json();

import requests

payload = {
    "FirstName": "Jane",
    "LastName": "Citizen",
    "ClientLookupId": "00000000-0000-0000-0000-000000000000",
    "RedirectUrl": "https://example.com/done",
    "GlobalScreening": [
        "idv"
    ],
    "CustomerIntelligence": [
        "emv"
    ]
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/instance/create',
    headers={
        "x-api-key": "YOUR_API_KEY"
    },
    json=payload
)
result = response.json()

using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var json = @"{
  ""FirstName"": ""Jane"",
  ""LastName"": ""Citizen"",
  ""ClientLookupId"": ""00000000-0000-0000-0000-000000000000"",
  ""RedirectUrl"": ""https://example.com/done"",
  ""GlobalScreening"": [
    ""idv""
  ],
  ""CustomerIntelligence"": [
    ""emv""
  ]
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/instance/create", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();