API Reference

The IDScan.net Screening Service Web API follows a RESTful design pattern. This Web API has predictable resource-oriented URLs, uses JSON to serialize responses, and uses standard HTTP verbs and response codes.

Base URL

https://screening.idware.net/

Authentication

The IDScan.net Screening API uses bearer tokens to authenticate requests. Anyone interested in using the Web API on a trial basis may request an bearer token by emailing support@idscan.net.

Authorization header using the bearer token scheme. Example: "Authorization: Bearer {token}"

Security scheme type: API Key
header parameter name: Authorization

Example Authenticated Request

curl -X POST https://screening.idware.net/api/Check -H "Content-Type: application/json" -H "Authorization: Bearer {token}"

Request

Please go to the specific service page to see all required fields in the request. Also, you can provide your own identifier by fill "ReferenceId" field in the request. You can populate it with some unique value and provide us with it in case of some problems with the request.

Response

Field "Error" in the response contains an error text message if there's something wrong while processing a request.

Field "Success" in the response indicates the status of the request. If there's Success status, then available requests count in service subscription will decrease by 1. If the request is sent to multiple services, there will be multiple bodies in the response., e.g.:

You sent a request to 2 services - IdentiFraud and Sex offender, so there will be response:

[{
    "serviceId":"211b428e-b8b5-4eb9-973d-106f013c371f",
    "serviceName":"IdentiFraud",
    "serviceDescription":"Authenticate a consumer by personal data",
    "error":null,
    "success":true,
    "profiles":[
    <profiles from IdentiFraud service>
    ]
},
{
    "serviceId":"3accf2a9-2e52-4675-b546-7c3676897c3c",
    "serviceName":"Sex offender",
    "serviceDescription":"Sex offender",
    "error":null,
    "success":true,
    "profiles":[
    <profiles from Sex offender service>
    ]
}]

API

Swagger UI