Product Statuses

Integration Guides API v2

Product statuses represent the outcome of each product within a workflow. Use the individual product statuses to determine the outcome of each verification or check. Use the workflow status to determine whether processing is in progress, has completed, or has failed.

Note

A product status of completed indicates only that the product finished processing successfully. It does not indicate that the verification outcome is positive or that the client should be approved. Always evaluate the product status, messages, risk results, and report data before making onboarding or payment decisions.


Where to find product statuses

Product statuses are available through the workflow status API, webhook events, and JSON reports. The JSON property depends on the endpoint.

Use caseAPIJSON pathProperty
Monitor workflow progressGet workflow statusproducts[].statusstatus
Process webhook eventsv2 webhook payloaddetails.statusstatus
Read final workflow resultsGet report as JSONproducts[].productStatusproductStatus

Status codes

Status codes provide additional information about a product's processing state, including validation errors, inconsistent data, and verification failures.

Depending on the integration, status codes may be returned in:

  • products[].messages in the workflow status response
  • details.messages in webhook events
  • JSON reports, when messages are included

Status code categories

Code or rangeCategoryAssociated product statuses
1000Validation successfulpending
1001-1999Validation errorsinvalid_data
2000 seriesAddress consistencyinconsistent_data
3000 seriesRecoverable sendbacksinconsistent_data
4000 seriesRejectioncompleted
5000 seriesFraudcompleted
6000-6015Qualified Electronic Signature (Signatures)error, pending, user_consent_required, confirmation_required
6050-6052eID verificationinconsistent_data
7000 seriesBank Account Verification (Payments)failed

For detailed descriptions, and required actions, see the product-specific status documentation.


Product-specific statuses

The following sections describe the available product status values and associated status codes.