Dashboard API - Single candidate

Get status of a single candidate

Get status by refId

tip

refId is the local user ID you may have assigned to a user in the widget.
If you did not assign a refId, you can use the recordId returned by the widget. See below.

Curl

curl -X GET \
  https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID> \
  -H 'Authorization: <API_Key>' \
  -H 'cache-control: no-cache'

Python

import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>", headers={"Authorization":"<api_key>"})

NodeJS

const request = require("request");

const options = {
  url: "https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>",
  method: "GET",
  headers: {
    Authorization: "<api_key>",
  },
};

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

Get status by recordId

tip

recordId is returned by the widget when data have been successfully submitted.

Curl

curl -X GET \
  https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID> \
  -H 'Authorization: <API_Key>' \
  -H 'cache-control: no-cache'

Python

import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>", headers={"Authorization":"<api_key>"})

NodeJS

const request = require("request");

const options = {
  url: "https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>",
  method: "GET",
  headers: {
    Authorization: "<api_key>",
  },
};

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

Response

Both routes above return current status and history of status changes

{
  "status": "success",
  "data": {
    "status": "inreview",
    "recordId": "5e5884feb785310019346655",
    "refId": "1849-4849-3848-1944",
    "isArchived": false,
    "blockPassID": "5fe95a995f8c44000e972445",
    "inreviewDate": "2018-11-12T10:49:17.973Z",
    "waitingDate": "2018-11-12T10:49:03.017Z"
  }
}