Skip to main content
GET
/
verifications
List verifications
curl --request GET \
  --url https://integration-api.dev.pawapass.com/verifications/ \
  --header 'X-AUTH-KEY: <api-key>'
{
  "items": [
    {
      "id": "aB1cD2eF",
      "externalId": "user-zm-98765",
      "requirements": [
        {
          "type": "DOCUMENT_SCAN"
        },
        {
          "type": "FACE_SCAN"
        }
      ],
      "url": "https://app.pawapass.com/your-company/aB1cD2eF",
      "status": "CREATED",
      "metadata": {
        "phoneNumber": "+260971234567",
        "jurisdiction": "ZM",
        "reason": "kyc-onboarding"
      },
      "successUrl": "https://your-website.com/success",
      "errorUrl": "https://your-website.com/error",
      "supportUrl": "https://your-website.com/support",
      "identityDocument": {
        "type": "Government Issued Photo ID",
        "country": "Zambia",
        "serialNo": "9876543/21/1",
        "nationalNo": "Z12345678",
        "firstName": "Tisa",
        "lastName": "Banda",
        "dateOfBirth": "1997-05-10",
        "placeOfBirth": "Lusaka",
        "nationality": "ZM",
        "expiryAt": "2032-05-09",
        "issuedAt": "2022-05-10",
        "issuingAuthority": "Republic of Zambia",
        "placeOfIssue": "Lusaka",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "createdBy": "[email protected]",
      "expiresAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}

Authorizations

​
X-AUTH-KEY
string
header
required

API key for partner authentication

Query Parameters

​
page
number
default:0
required

The page number to retrieve

Required range: x >= 0
​
limit
number
default:15
required

The number of items to return per page

Required range: 1 <= x <= 50
​
id
string

Filter by verification ID

​
externalId
string

Filter by your external ID

​
statuses
enum<string>[]

Filter by status. Supports multiple values (e.g., ?statuses=APPROVED&statuses=DECLINED)

Available options:
CREATED,
STARTED,
EXPIRED,
USER_DATA_COLLECTED,
REVIEW,
APPROVED,
DECLINED
​
fromCreatedAt
string<date-time>

Filter verifications created from this date (inclusive). Format ISO 8601

​
toCreatedAt
string<date-time>

Filter verifications created up to this date (inclusive). Format ISO 8601

​
firstName
string

Filter by the first name found on the identity document (case-insensitive partial match)

​
lastName
string

Filter by the last name found on the identity document (case-insensitive partial match)

​
serialNo
string

Filter by the serial number of the identity document (case-insensitive partial match)

​
nationalNo
string

Filter by the national number of the identity document (case-insensitive partial match)

​
dateOfBirth
string<date>

Filter by the date of birth found on the identity document (exact match, format YYYY-MM-DD)

Response

Default Response

​
items
object[]
required
​
count
number
required

The total number of items matching the filters