You can retrieve metrics regarding the AVS sessions that have been created using your API keys by calling the endpoint below:
GET https://age.yoti.com/api/v1/report/fetch-summary-statsHeaders
| Header | Description |
|---|---|
| Authorisation | API Key to call the Yoti Age API. Should be sent as a 'Bearer {{API_TOKEN}}'. |
| Yoti-Sdk-Id | Your unique SDK ID (uuid). |
Query parameters
| Parameter | Description | Type |
|---|---|---|
| createdAfter | Metrics will be returned for all session created after this date. Metrics will fetch data for up to six months. | dateTime |
| createdBefore | Metrics will be returned for all session created before this date. Metrics will fetch data for up to six months. | dateTime |
Example response
{ "time_period_of_results": {}, "total_created_sessions": 16, "total_complete_sessions": 7, "total_failed_sessions": 2, "total_pending_sessions": 4, "total_cancelled_sessions": 1, "total_inprogress_sessions": 0, "total_errored_sessions": 2, "address_direct_check": {}, "age_estimation": {}, "age_estimation_direct_check": {}, "digital_id": {}, "doc_scan": {}, "credit_card": {}, "mobile": {}, "mobile_direct_check": {}, "mit_id": {}, "swedish_bank_id": {}, "ftn": {}, "la_wallet": {}, "login": {}, "social_security_number": {}}Yoti Hub analytics
Coming soon!
Scheduled reporting
If you require scheduled monthly reporting of our services, please get in contact with us.
You will need to send us:
- Your business account name with Yoti.
- The Service you have integrated.
- The frequency you want the reports.
Was this page helpful?