API health

Be aware of the API service status on a daily basis.

API health refers to the availability, performance, and functional correctness of not just API endpoints, but also supported transactions.

Monitoring the service operational status is helpful if you want to evaluate how the API performs and be aware of any potential degradation.

Monitor webhook statistics

Review statistics on sent webhooks:

  1. In the Dashboard, go to the Webhooks page.
  2. Provide an applicant ID, select a webhook type and status.

The following table explains metrics available for the webhook monitoring.

Field

Description

Applicant

Applicant ID for which a webhook was sent. The ID is presented as a link to the applicant profile and marked with a colored bullet point that refers to the webhook status:

  • Green — webhook sent successfully.
  • Red — webhook sending failed.
  • Black — webhook sending failed 5 times in a row or there was a critical failure.

Name

Webhook name.

Created

Webhook creation date and time.

Last Sent

Date and time when the webhook was last sent.

Next Scheduled

Date and time the webhook is scheduled to be sent. An empty cell means that webhook sending is not planned.

# Failures

Number of failed attempts to send the webhook.

HTTP Code

HTTP status code that was returned in response.

Error

Description of the error occurred while sending the webhook.

Actions

Resend button to manually send the webhook.

See API usage

Review the Sumsub API overall usage statistics for the selected period:

  • API response codes. Graph that shows how the API reacted to your calls over time. You can see the number of calls, date and time of the call, and call results:
  • Request count by IPs. Table that lets you view the number of requests and IPs from which they were sent.

Get health statistics via API

Check the API availability using this method.