The Incognia Onboarding API delivers frictionless identity verification that reduces time to verify and onboard trusted users, and detects application fraud. It compares the address provided in an application with the current and past location behavior of the device to assess whether the new user actually lives at that address and delivers a risk assessment and supporting evidence.
When a device is new to the Incognia network, Incognia determines whether the new user is currently at the address claimed during onboarding and if not, how far away they are. At the same time, it continues to collect location data and provides an updated risk assessment within 48 hours. If the information provided during the onboarding process does not match the device's location behavior pattern, Incognia delivers a high risk score.
In order to assess a new signup, Incognia needs to receive an Installation ID to identify the device from which it originates. It also may optionally receive the address declared by the user.
address_line
or structured_address
. Also, informing the address_coordinates
drastically improves the accuracy of the results.structured_address
if both are informed.{"id": "5e76a7ca-577c-4f47-a752-9e1e0cee9e49","request_id": "8afc84a7-f1d4-488d-bd69-36d9a37168b7","risk_assessment": "low_risk","evidence": {// For a complete explanation of this part of the response,// please refer to the evidence page in the docs."device_model": "Moto Z2 Play","geocode_quality": "good","location_events_near_address": 38,"location_events_quantity": 288,"location_services": {"location_permission_enabled": true,"location_sensors_enabled": true},"device_integrity": {"probable_root": false,"emulator": false,"gps_spoofing": false,"from_official_store": true}}}
installation_id
Empty.
Empty.
Unable to find user device information. Please try again later and check your SDK integration
Empty.
Empty.
{"installation_id": "LX2K9uIfkPIL2UIXxQCqSXDTPKkG8gLG2heKnlMrwAaCLV2KHxuji1WLElDrFBlWYJLCwbkghZVmp5WVb6UAjfxlgcExS3W1fgQ4j0ikcp7Z8x9dGTaYcVFXVf0fupbcvhI8Nh0RO9oy+3NavbBX7Q","address_line": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200"}
{"installation_id": "LX2K9uIfkPIL2UIXxQCqSXDTPKkG8gLG2heKnlMrwAaCLV2KHxuji1WLElDrFBlWYJLCwbkghZVmp5WVb6UAjfxlgcExS3W1fgQ4j0ikcp7Z8x9dGTaYcVFXVf0fupbcvhI8Nh0RO9oy+3NavbBX7Q","structured_address": {"locale": "pt-BR","country_name": "Brazil","country_code": "BR","state": "SP","city": "São Paulo","borough": "","neighborhood": "Bela Vista","street": "Av. Paulista","number": "1578","complements" : "Andar 2","postal_code": "01310-200"}}
{"installation_id": "LX2K9uIfkPIL2UIXxQCqSXDTPKkG8gLG2heKnlMrwAaCLV2KHxuji1WLElDrFBlWYJLCwbkghZVmp5WVb6UAjfxlgcExS3W1fgQ4j0ikcp7Z8x9dGTaYcVFXVf0fupbcvhI8Nh0RO9oy+3NavbBX7Q","address_line": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200","address_coordinates": {"lat": -23.561414,"lng": -46.6558819}}
Sample cURL request
curl -XPOST -H "Content-type: application/json" -H "Authorization: Bearer <token>" -d @body.json "https://api.us.incognia.com/api/v2/onboarding/signups"
Response body
For a 200-OK response, these are the fields you should expect as a result:
Response field | Type | Description |
id | string | Unique signup identifier which can be used to verify if the assessment changed in later calls. |
request_id | string | Unique request identifier. Used for audit purposes. |
risk_assessment | string | Assessment result. It may be one of high_risk, low risk, unknown risk. For more information refer to Understanding risk assessments. |
evidence | object | An object with supporting evidence for the risk assessment. For more information refer to Understanding risk assessments. |
{"id": "5e76a7ca-577c-4f47-a752-9e1e0cee9e49","request_id": "8afc84a7-f1d4-488d-bd69-36d9a37168b7","risk_assessment": "low_risk","evidence": {// For a complete explanation of this part of the response,// please refer to the evidence page in the docs."device_model": "Moto Z2 Play","geocode_quality": "good","location_events_near_address": 38,"location_events_quantity": 288,"location_services": {"location_permission_enabled": true,"location_sensors_enabled": true},"device_integrity": {"probable_root": false,"emulator": false,"gps_spoofing": false,"from_official_store": true}}}
Empty.
Unable to find the given sign up id.
Empty.
Sample cURL request
curl -H "Authorization: Bearer <token>" "https://api.us.incognia.com/api/v2/onboarding/signups/<id>"
Response body
For a 200-OK response, these are the fields you should expect as a result:
Response field | Type | Description |
id | string | Unique signup identifier which can be used to verify if the assessment changed in later calls. |
request_id | string | Unique request identifier. Used for audit purposes. |
risk_assessment | string | Assessment result. It may be one of high_risk, low risk, unknown risk. For more information refer to Understanding risk assessments. |
evidence | object | An object with supporting evidence for the risk assessment. For more information refer to Understanding risk assessments. |
address_line
or structured_address
. Also, informing the address_coordinates
drastically improves the accuracy of the results.
Warning: This endpoint is coming soon. Please consult with the Incognia team before use.structured_address
if both are informed.{"id": "5e76a7ca-577c-4f47-a752-9e1e0cee9e49","request_id": "8afc84a7-f1d4-488d-bd69-36d9a37168b7","risk_assessment": "low_risk","evidence": {// For a complete explanation of this part of the response,// please refer to the evidence page in the docs."device_model": "Moto Z2 Play","geocode_quality": "good","location_events_near_address": 38,"location_events_quantity": 288,"location_services": {"location_permission_enabled": true,"location_sensors_enabled": true},"device_integrity": {"probable_root": false,"emulator": false,"gps_spoofing": false,"from_official_store": true}}}
Empty.
Unbale to find given sign up id.
Empty.
{"address_line": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200"}
{"structured_address": {"locale": "pt-BR","country_name": "Brazil","country_code": "BR","state": "SP","city": "São Paulo","borough": "","neighborhood": "Bela Vista","street": "Av. Paulista","number": "1578","complements" : "Andar 2","postal_code": "01310-200"}}
{"address_line": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP, 01310-200","address_coordinates": {"lat": -23.561414,"lng": -46.6558819}}
Sample cURL request
curl -XPUT -H "Content-type: application/json" -H "Authorization: Bearer <token>" -d @body.json "https://api.us.incognia.com/api/v2/onboarding/signups/<id>"
Response body
For a 200-OK response, these are the fields you should expect as a result:
Response field | Type | Description |
id | string | Unique signup identifier which can be used to verify if the assessment changed in later calls. |
request_id | string | Unique request identifier. Used for audit purposes. |
risk_assessment | string | Assessment result. It may be one of high_risk, low risk, unknown risk. For more information refer to Understanding risk assessments. |
evidence | object | An object with supporting evidence for the risk assessment. For more information refer to Understanding risk assessments. |