PApaddlehq
Verifications

List verifications

Changed on

Returns a paginated list of verifications. Use the query parameters to page through results.

Filter by verification_type=onboarding and use the returned verification's status to check whether your account is ready for live payments or needs action.

get/verifications

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Query parameters

idstring[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

verification_type'onboarding' | 'domain'

Type of verification.

Filter verifications by type. If omitted, verifications of all types are returned.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "slrvrf_01gjn16x6xxb6vkznqwfphthxb",
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "steps": [
        {
          "id": "slrvrfstp_01hksn4p20bgwhe1szzep44dmt",
          "expires_at": "2024-10-12T07:20:50.52Z",
          "created_at": "2024-10-12T07:20:50.52Z",
          "updated_at": "2024-10-13T07:20:50.52Z"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes