Identity

Allows access to End user’s personal information held by the Provider

post
Identity

https://api.dapi.co/v1/data/Identity
Request
Response
Headers
Authorization
required
string
Bearer <accessToken>
Body Parameters
userSecret
required
string
User Secret from Connect
addresses
optional
array
Webhook URL(s) to send data to. If empty an update will be sent to all webhook urls defined in app settings
sync
optional
boolean
true or false , if set the connection is maintained till the result is returned
appSecret
required
string
App Secret from the dashboard
200: OK
Response
// Asynchronous response
{
"jobID": "83515136-9146-523a-9936-3229d51fd49d",
"msg": "Job Intitalized",
"success": null
}
// Synchronous and Webhook Response
{
"jobID": "83515136-9146-523a-9936-3229d51fd49d",
"msg": "Job Finished",
"success": true,
"result": {
"Identity": {
"nationality": "China",
"dateOfBirth": "1993-10-11T20:00:00.000Z",
"passportNumber": "A12345678",
"mobileNumber": "971(50)1234567",
"emailAddress": "dUser1@dapi.co",
"firstName": "dapi",
"lastName": "user",
"address": {
"flat": "555",
"building": null,
"area": null,
"poBox": "000",
"city": "DXB",
"emirate": "DUBAI",
"country": "UNITED ARAB EMIRATES"
}
}
}
}
422: Unprocessable Entity
{
"msg": "Parameters validation error!",
"success": false,
"field": "appSecret",
"err": "The 'appSecret' field is required!"
}