Skip to main content

Dashboard API - Single candidate

Get all data for a single candidate​

Get status and raw data by refId​

caution

You must select Include Identity attributes option when creating your API key to get all data of the user in the response.

tip

refId is the Local User ID (uuid) you may have assigned to a user in thewidget.
If you did not assign a refId, you can use the recordId returned by the widget. See below.

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

Get status and raw data by recordId​

caution

You must select Include Identity attributes option when creating your API key to get all data of the user in the response.

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

Response​

Both routes above returns

{
  "status": "success",
  "data": {
    "status": "inreview",
    "refId": "1",
    "isArchived": false,
    "blockPassID": "5be95a995f8c44000e972445",
    "inreviewDate": "2018-11-12T10:49:17.973Z",
    "waitingDate": "2018-11-12T10:49:03.017Z",
    "customFields": {
      "RiskLevel": "Low"
    },
    "identities": {
      "address": {
        "type": "string",
        "value": "{\"postalCode\":\"62576-6471\",\"city\":\"Luettgenchester\",\"address\":\"4611 Zieme Knoll\",\"extraInfo\":\"extra\",\"country\":\"VNM\",\"state\":\"\"}"
      },
      "dob": {
        "type": "string",
        "value": "12/31/2016"
      },
      "email": {
        "type": "string",
        "value": "52777-50830-Alexandre42@yahoo.com"
      },
      "family_name": {
        "type": "string",
        "value": "StromanBot"
      },
      "given_name": {
        "type": "string",
        "value": "Helmer"
      },
      "phone": {
        "type": "string",
        "value": "{\"countryCode\":\"VNM\",\"countryCode2\":\"vn\",\"phoneNumber\":\"+84987543212\",\"number\":\"987543212\"}"
      },
      "selfie_national_id": {
        "type": "base64",
        "value": "/9j/4AAQSkZJRgABAQEASABIAAD/<...>"
      },
      "proof_of_address": {
        "type": "base64",
        "value": "/9j/4AAQSkZJRgABAQEASABI<...>"
      },
      "selfie": {
        "type": "base64",
        "value": "/9j/4AAQSkZJRgABAQEA<...>"
      },
      "passport": {
        "type": "base64",
        "value": "/9j/4AAQSkZJ<...>"
      }
    },
    "certs": {
      "cert1": "{\"@context\":[{\"@version\":1.1},,<...>",
      "cert2": "{\"@context\":[{\"@version\":1.1},<...>"
    }
  }
}