Get a list of identifications

You can call the API to get a list of all of your user's identifications.

Identification information is also available on your Dashboard > Data > Users.

Prerequisites

You need a project access token to call the query.

Guide

1. Call the user query.
2. Add the user ID.
3. Add all information you'd like to review. The sample query adds all status information, as well as the totalCount of identifications.
   • Notice the nodes process, status, and updatedAt, which provide information about which process was used and the identification status with that process.
   • Further, notice the levels, and the information that will be shared if there is an invalid status connected to that level.
4. Consider adding pagination if you're expecting a long list.

Query

🔎 Open the query in API Explorer

query ListOfIdentifications {
  user(id: "$YOUR_USER_ID") {
    identifications {
      edges {
        node {
          process
          status
          updatedAt
          levels {
            expert {
              ... on InvalidIdentificationLevelStatusInfo {
                __typename
                reasons
                status
              }
              ... on ValidIdentificationLevelStatusInfo {
                __typename
                status
              }
            }
            qes {
              ... on InvalidIdentificationLevelStatusInfo {
                __typename
              }
              ... on ValidIdentificationLevelStatusInfo {
                __typename
                status
              }
            }
            pvid {
              ... on InvalidIdentificationLevelStatusInfo {
                __typename
              }
              ... on ValidIdentificationLevelStatusInfo {
                __typename
                status
              }
            }
          }
        }
      }
      totalCount
    }
  }
}

Payload

In the payload, note the Valid PVID and Expert processes (lines 9, 24).

The QES process, however, is Invalid. This is because, when completing the Expert level identification (which is a step in the QES process), the user had BadDocumentLighting (line 48), which is just one possible rejection reason.

Finally, note the empty {} when there is no information to share based on the query parameters. This is expected behavior.

{
  "data": {
    "user": {
      "identifications": {
        "edges": [
          {
            "node": {
              "process": "Expert",
              "status": "Valid",
              "updatedAt": "2023-11-29T09:15:25.978Z",
              "levels": {
                "expert": {
                  "__typename": "ValidIdentificationLevelStatusInfo",
                  "status": "Valid"
                },
                "qes": {},
                "pvid": {}
              }
            }
          },
          {
            "node": {
              "process": "PVID",
              "status": "Valid",
              "updatedAt": "2023-11-28T17:00:23.903Z",
              "levels": {
                "expert": {
                  "__typename": "ValidIdentificationLevelStatusInfo",
                  "status": "Valid"
                },
                "qes": {},
                "pvid": {
                  "__typename": "ValidIdentificationLevelStatusInfo",
                  "status": "Valid"
                }
              }
            }
          },
          {
            "node": {
              "process": "QES",
              "status": "Invalid",
              "updatedAt": "2023-11-24T10:49:40.470Z",
              "levels": {
                "expert": {
                  "__typename": "InvalidIdentificationLevelStatusInfo",
                  "reasons": [
                    "BadDocumentLightning"
                  ],
                  "status": "Invalid"
                },
                "qes": {
                  "__typename": "InvalidIdentificationLevelStatusInfo"
                },
                "pvid": {}
              }
            }
          },
        ],
        "totalCount": 3
      }
    }
  }
}