Checking Consent Requirements

The current list of services and jurisdictions that require consent is returned by the API as part of the service description. The "requirements" array is the same in both endpoints.

GET /api/Services

All services on the platform.

Request:

curl -X GET "https://screening.idscan.net/api/Services" -H "Content-Type: application/json" -H "Authorization: Bearer {token}"

Response:

[
  {
    "id": "f1366c39-d0cd-458c-81f8-efd7b0753a5b",
    "friendlyName": "DMV Verification",
    "description": "Driver License Data Verification",
    "billingType": 1,
    "requirements": [
      {
        "type": 1,
        "name": "ConsentForm",
        "states": [
          "PA"
        ]
      }
    ]
  }
]

GET /api/Customer/services

Only the services enabled for your account. The response also includes the subscription state.

Request:

curl -X GET "https://screening.idscan.net/api/Customer/services" -H "Content-Type: application/json" -H "Authorization: Bearer {token}"

Response:

[
  {
    "id": "f1366c39-d0cd-458c-81f8-efd7b0753a5b",
    "friendlyName": "DMV Verification",
    "description": "Driver License Data Verification",
    "billingType": 1,
    "status": "488 requests left",
    "isAvailable": true,
    "requirements": [
      {
        "type": 1,
        "name": "ConsentForm",
        "states": [
          "PA"
        ]
      }
    ],
    "requestQuantity": 500,
    "requestUsed": 12
  }
]

"requirements" lists the requirements of the service. "type": 1, "name": "ConsentForm" is the consent form; "states" holds the codes of the jurisdictions where it is required.