Mobile
Overview
Verify your user is over 18 using their mobile provider details.
Mobile phone numbers can be checked against data sources connected to the mobile number which can help ascertain a user's over 18 status. You should ensure the phone is in the possession of the contract holder before checking their details and be aware parents can take out contracts for their children.
Good for:
- Accounts linked to a mobile number
- Background checks
- Specific countries
Yoti will send the user’s details to one of our data providers. Yoti offers the ability to send the user an OTP ahead of performing the check, this is to confirm they are in possession of the phone. Once the check is complete, the provider confirms the user’s details from their mobile account which are used to determine that the user is over 18.
We never store or share the user’s details with anyone other than the provider.
Mobile - Headless check
Send mobile OTP
When verifying someones age via the mobile method, you can optionally send a one time password (OTP) to the phone number that the user provides, to ensure they have access to this mobile phone. If the phone number has already been verified (i.e. through a pre-existing OTP), this step may be skipped.
POST https://age.yoti.com/api/v1/mobile/otp| Header | Description |
|---|---|
| Authorization | API Key to call the Yoti Age API. Should be sent as a Bearer token. |
| Content-Type | application/json |
| Yoti-SDK-Id | Your unique Yoti-Sdk-Id (uuid) |
Request body
{ "phone_number": "phoneNumber", "consent_id": "Unique_ID"}| Parameter | Types | Description |
|---|---|---|
| phone_number | String | This should be the target phone number to receive an OTP, including the country prefix. |
| consent_id | String | Reference stored by the telco for each check. |
Example response
{ "success": true}Mobile check
POST https://age.yoti.com/api/v1/mobile/check| Header | Description |
|---|---|
| Authorization | API Key to call the Yoti Age API. Should be sent as a Bearer token. |
| Content-Type | application/json |
| Yoti-SDK-Id | Your unique Yoti-Sdk-Id (uuid) |
Request body
{ "phone_number": "phoneNumber", "consent_id": "Unique_ID", "otp": "OTP_Code" //optional}| Parameter | Types | Description |
|---|---|---|
| phone_number | String | The phone number to verify. This must include the country code prefix. |
| consent_id | String | Reference stored by the telco for each check. |
| otp* | String | Optional, if an OTP was requested, this can be sent to verify the recipient has received the OTP. If the phone number is already verified, an OTP may not be required. |
Example response
{ "method": "MOBILE", "type": "OVER", "threshold": 18, "age": 18, "result": true, "status": "COMPLETE", "evidence_id": "ef4846dd-10fa-4c1b-ba81-f9046c698c8a"}| Field | Description |
|---|---|
| method | The AV method used. MOBILE is returned for mobile checks |
| type | Dictates the threshold type. For mobile checks only OVER is returned |
| threshold | The age threshold that has been met |
| age | The age threshold that has been met |
| result | Returns true if the threshold (18) has been met. Returns false if not met, or on error |
| status | COMPLETE - The phone number has been associated with an Over 18 individual ERROR - We could not provide an age result, because we didn't have enough info associated with that phone number FAIL - The phone number has been associated with an Under 18 individual |
| evidence_id | The Evidence ID can be re-shared with Yoti to provide evidence that a check of a mobile phone number was performed. The mobile phone number or associated personal information is not stored by Yoti, this can never be retrieved. Yoti will be able to confirm that a check took place at a specific time, the processing steps and result of the check |
Error codes
| Error Code | Description |
|---|---|
| E200001 | Internal server error |
| E200003 | Unable to get a response from requesting OTP |
| E200006 | Invalid country code |
| E200007 | Bad request |
| E200008 | Unauthorised |
| E200009 | Not allowed |
| E200010 | Not found |
| E200011 | Invalid message template |
| E200012 | Phone number not whitelisted |
| E200013 | Error received from supplier |