For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Paddle Docs home

List verifications

Returns a paginated list of verifications.

GET/verifications

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.

Requires verification.read permission.

Query parameters

idarray
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
Default: 50

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.

Max: 200
verification_typestring
Type of verification.
Values
  • onboarding
    A verification created as part of account onboarding.
  • domain
    A verification created for a domain review.
order_bystring
Default: id[DESC]

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

Valid fields for ordering: id.

Header parameters

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 (200)

dataarrayrequired
idstringrequired
Example: slrvrf_01gjn16x6xxb6vkznqwfphthxb
Unique Paddle ID for this verification entity, prefixed with slrvrf_.
Pattern: ^slrvrf_[a-z\d]{26}$
statusstringrequired
Overall status of the verification, derived from the status of its steps. pending until the first step exists.
Values
  • pending
    Verification hasn't started, or is waiting for its next step to start.
  • in_progress
    Paddle is running automated checks. No input is required.
  • in_review
    Paddle is reviewing the information provided by the account holder.
  • action_required
    Action is required before the verification can continue.
  • completed
    Verification is complete. For an onboarding verification, the account is ready for live payments.
+ Show all values
  • failed
    Verification didn't complete.
verification_typestringrequired
Type of verification. An account has at most one onboarding verification.
Values
  • onboarding
    A verification created as part of account onboarding.
  • domain
    A verification created for a domain review.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
stepsarrayrequired
Verification steps that make up this verification.
idstringrequired
Example: slrvrfstp_01hksn4p20bgwhe1szzep44dmt
Unique Paddle ID for this verification step entity, prefixed with slrvrfstp_.
Pattern: ^slrvrfstp_[a-z\d]{26}$
keystringrequired
Key of the verification step.
Values
  • account_setup
    The account holder submits the prerequisite account details.
  • domain_review
    Paddle reviews the domain.
  • business_identification
    Paddle validates the business. Public companies and sole traders don't need this step.
  • identity_verification
    Paddle validates the stakeholders of the business. Public companies don't need this step.
  • final_review
    Paddle performs a manual review of the business.
+ Show all values
  • automated_review
    Paddle submits the business to a third-party provider for automated review. Where an account has no completed domain verification yet, this step stays pending until one completes.
statusstringrequired

Status of the verification step.

Steps are created as pending initially, then move through in_progress and in_review states as Paddle processes each step.

Values
  • pending
    This step hasn't started yet.
  • in_progress
    Paddle is running automated checks for this step. No input is required.
  • in_review
    Paddle is reviewing this step.
  • action_required
    Action is required before this step can continue.
  • failed
    This step didn't complete.
+ Show all values
  • completed
    This step is complete and no further action is required.
expires_atstring (date-time) | nullrequired
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this step expires. null if this step never expires.
created_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example: 2024-10-13T07:20:50.52Z
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
metaobjectrequired
Information about this response.
request_idstringrequired
Example: b15ec92e-8688-40d4-a04d-f44cbec93355
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
paginationobjectrequired
Keys used for working with paginated results.
per_pageintegerrequired
Number of entities per page for this response. May differ from the number requested if the requested number is greater than the maximum.
nextstring (uri)required
URL containing the query parameters of the original request, along with the after parameter that marks the starting point of the next page. Always returned, even if has_more is false.
has_morebooleanrequired
Whether this response has another page.
estimated_totalinteger
Example: 999

Estimated number of entities for this response.

For datasets with 100,000 or fewer matches, returns the exact count. For datasets with more than 100,000 matches, returns 100001 to indicate that more than 100,000 entities match. Returns -1 when counting is skipped or couldn't be calculated.

Use has_more and next to page through all results rather than relying on estimated_total for an exact count.

Response
{
  "data": [
    {
      "id": "slrvrf_01jjr5d4c14h4y3lqlk9bedkw7",
      "verification_type": "onboarding",
      "status": "action_required",
      "steps": [
        {
          "id": "slrvrfstp_01jjr5d4c14h4y3lqlk9bedkw8",
          "key": "account_setup",
          "status": "completed",
          "expires_at": null,
          "created_at": "2025-03-10T10:30:00.00Z",
          "updated_at": "2025-03-10T10:30:00.00Z"
        },
        {
          "id": "slrvrfstp_01jjr5d4c14h4y3lqlk9bedkw9",
          "key": "automated_review",
          "status": "action_required",
          "expires_at": null,
          "created_at": "2025-03-10T10:30:00.00Z",
          "updated_at": "2025-03-10T10:30:00.00Z"
        }
      ],
      "created_at": "2025-03-10T10:30:00.00Z",
      "updated_at": "2025-03-10T10:30:00.00Z"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 50,
      "estimated_total": 1,
      "next": "https://api.paddle.com/verifications?after=slrvrf_01jjr5d4c14h4y3lqlk9bedkw7",
      "has_more": false
    },
    "request_id": "80e30719-f099-52de-92c4-1d2b7b7247f3"
  }
}

Was this page helpful?