Dashboard API - Status of all candidates

Get status of all candidates

Retrieve current status of all KYC applications

Curl
Python
NodeJS

curl -X GET \
  https://kyc.blockpass.org/kyc/1.0/connect/_CLIENT_ID_/applicants/_OPTIONAL_STATUS_ \
  -H 'Authorization: _API_Key_' \
  -H 'cache-control: no-cache'

import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/_CLIENT_ID_/applicants/_OPTIONAL_STATUS_", headers={"Authorization":"_api_key_"})

const request = require("request");

const options = {
  url: "https://kyc.blockpass.org/kyc/1.0/connect/_CLIENT_ID_/applicants/_OPTIONAL_STATUS_",
  method: "GET",
  headers: {
    Authorization: "_api_key_",
  },
};

request(options, function (error, response, body) {
  console.log(response);
});

Path parameters:

STATUS (optional): Default value return all statuses. Possible values for specific filter (waiting | inreview | approved | rejected | blocked | review_requested)

Query parameters:

skip (optional) : Number of records skipped
limit (optional) : Maximum of records returned

returns the list of applicants and their current KYC statuses

{
  "status": "success",
  "data": {
    "records": [
      {
        "status": "waiting",
        "refId": "1552449235127",
        "submitCount": 1,
        "blockPassID": "5c887dfc640a9d000edf2f12",
        "isArchived": false,
        "waitingDate": "2019-03-13T03:51:01.504Z",
        "customFields": {
          "RiskLevel": "Low"
        },
        "identities": {
          "email": {
            "type": "string",
            "value": "[email protected]"
          },
          "family_name": {
            "type": "string",
            "value": "name"
          },
          "given_name": {
            "type": "string",
            "value": "gname"
          }
        },
        "certs": {
          "certificate_slug": "{\"@context\":[{\"@version\":1.1},,<...>"
        }
      },
      {
        "status": "approved",
        "refId": "142929235127",
        "submitCount": 1,
        "blockPassID": "8c8997dfc6430a9d000edf2f12",
        "isArchived": false,
        "waitingDate": "2019-03-13T03:51:01.504Z",
        "customFields": {
          "RiskLevel": "High"
        },
        "identities": {
          "email": {
            "type": "string",
            "value": "[email protected]"
          },
          "family_name": {
            "type": "string",
            "value": "name"
          },
          "given_name": {
            "type": "string",
            "value": "gname"
          }
        },
        "certs": {
          "certificate_slug": "{\"@context\":[{\"@version\":1.1},,<...>"
        }
      }
    ],
    "total": 2,
    "skip": 0,
    "limit": 5
  }
}

Get status of all candidates​

Get status of all candidates