Docs › API reference › Electronic identity verification

Electronic identity verification 1x1

Looks for a match on a single database.

POSThttps://api.screenlyyid.com/api/v1/eid-validate-1x1

Headers#

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

Request body#

Field	Type	Required
`Address`	object	No
`Address.AddressLine1`	string	No
`Address.AddressLine2`	string	No
`Address.HouseNumber`	string	No
`Address.HouseNumberAddition`	string	No
`Address.Thoroughfare`	string	No
`Address.Locality`	string	No
`Address.PostalCode`	string	No
`Address.Province`	string	No
`Address.CountryCode`	string	No
`Identity`	object	No
`Identity.Completename`	string	No
`Identity.Givenfullname`	string	No
`Identity.SurnameFirst`	string	No
`Identity.Nationalid`	string	No
`Identity.Dob`	string	No
`Phone`	object	No
`Phone.PhoneNumber`	string	No
`Email`	object	No
`Email.FullEmailAddress`	string	No

Responses#

Status	Description
`200`	Successful response

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/eid-validate-1x1' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "Address": {
    "AddressLine1": "<AddressLine1>",
    "AddressLine2": "<AddressLine2>",
    "HouseNumber": "<HouseNumber>",
    "HouseNumberAddition": "<HouseNumberAddition>",
    "Thoroughfare": "<Thoroughfare>",
    "Locality": "<Locality>",
    "PostalCode": "<PostalCode>",
    "Province": "<Province>",
    "CountryCode": "AU"
  },
  "Identity": {
    "Completename": "<Completename>",
    "Givenfullname": "<Givenfullname>",
    "SurnameFirst": "<SurnameFirst>",
    "Nationalid": "<Nationalid>",
    "Dob": "<Dob>"
  },
  "Phone": {
    "PhoneNumber": "+61412345678"
  },
  "Email": {
    "FullEmailAddress": "person@example.com"
  }
}'

const body = {
  "Address": {
    "AddressLine1": "<AddressLine1>",
    "AddressLine2": "<AddressLine2>",
    "HouseNumber": "<HouseNumber>",
    "HouseNumberAddition": "<HouseNumberAddition>",
    "Thoroughfare": "<Thoroughfare>",
    "Locality": "<Locality>",
    "PostalCode": "<PostalCode>",
    "Province": "<Province>",
    "CountryCode": "AU"
  },
  "Identity": {
    "Completename": "<Completename>",
    "Givenfullname": "<Givenfullname>",
    "SurnameFirst": "<SurnameFirst>",
    "Nationalid": "<Nationalid>",
    "Dob": "<Dob>"
  },
  "Phone": {
    "PhoneNumber": "+61412345678"
  },
  "Email": {
    "FullEmailAddress": "person@example.com"
  }
};

const response = await fetch(
  "https://api.screenlyyid.com/api/v1/eid-validate-1x1",
  {
    "method": "POST",
    "headers": {
      "x-api-key": "YOUR_API_KEY",
      "x-correlation-id": "YOUR_CORRELATION_ID",
      "Content-Type": "application/json"
    },
    "body": JSON.stringify(body)
  }
);

const result = await response.json();

import requests

payload = {
    "Address": {
        "AddressLine1": "<AddressLine1>",
        "AddressLine2": "<AddressLine2>",
        "HouseNumber": "<HouseNumber>",
        "HouseNumberAddition": "<HouseNumberAddition>",
        "Thoroughfare": "<Thoroughfare>",
        "Locality": "<Locality>",
        "PostalCode": "<PostalCode>",
        "Province": "<Province>",
        "CountryCode": "AU"
    },
    "Identity": {
        "Completename": "<Completename>",
        "Givenfullname": "<Givenfullname>",
        "SurnameFirst": "<SurnameFirst>",
        "Nationalid": "<Nationalid>",
        "Dob": "<Dob>"
    },
    "Phone": {
        "PhoneNumber": "+61412345678"
    },
    "Email": {
        "FullEmailAddress": "person@example.com"
    }
}

response = requests.post(
    'https://api.screenlyyid.com/api/v1/eid-validate-1x1',
    headers={
        "x-api-key": "YOUR_API_KEY",
        "x-correlation-id": "YOUR_CORRELATION_ID"
    },
    json=payload
)
result = response.json()

using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
client.DefaultRequestHeaders.Add("x-correlation-id", "YOUR_CORRELATION_ID");
var json = @"{
  ""Address"": {
    ""AddressLine1"": ""<AddressLine1>"",
    ""AddressLine2"": ""<AddressLine2>"",
    ""HouseNumber"": ""<HouseNumber>"",
    ""HouseNumberAddition"": ""<HouseNumberAddition>"",
    ""Thoroughfare"": ""<Thoroughfare>"",
    ""Locality"": ""<Locality>"",
    ""PostalCode"": ""<PostalCode>"",
    ""Province"": ""<Province>"",
    ""CountryCode"": ""AU""
  },
  ""Identity"": {
    ""Completename"": ""<Completename>"",
    ""Givenfullname"": ""<Givenfullname>"",
    ""SurnameFirst"": ""<SurnameFirst>"",
    ""Nationalid"": ""<Nationalid>"",
    ""Dob"": ""<Dob>""
  },
  ""Phone"": {
    ""PhoneNumber"": ""+61412345678""
  },
  ""Email"": {
    ""FullEmailAddress"": ""person@example.com""
  }
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.screenlyyid.com/api/v1/eid-validate-1x1", content);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadAsStringAsync();