Method is used to retrieve personal details about the user.

📘
Note
Information returned differs for each bank. The document describes all the information that can possibly be returned by the service, but depending on the bank, not all of this data may be provided.

It can be used to retrieve following information:

User Address
Contact Information
- Telephone Numbers
- Email Address
Legal Documentation (Proof Of User Identity)
User Details
- Nationality
- Date of Birth
- Full Name

👍
Pre-Requirement
You have obtained user's permanent access token from Exchange Token endpoint
To read more about authentication process and access token please refer to Authentication Documentation

Request

https://api.dapi.com/v2/data/identity/get

Headers

Parameter	Type	Description
Authorization REQUIRED	`String`	Set type to bearer token and the value to the `accessToken` obtained using the Exchange Token request.

Body Parameters

Parameter	Type	Description
appSecret REQUIRED	`String`	Private token generated at application creation.
userSecret REQUIRED	`String`	Encrypted version of the `userKey`.
userInputs OPTIONAL	`Array<userInputs>`	Array of UserInputs object, required only if initial request responded with user inputs specification. You can read more about user inputs specification on Specify User Input

Request Example

{
    "appSecret": "00bae841ad979345fca2e2585c000da7eac420504d189cf63315e7a6234d45c68dbd6fff749167292cd1475622805dce7a2b979db3c16e25a2897158ee63845b1043930ff603e19deb1d2d54ad9afc3d52df241d3c4e7286244a2f98a10212e38b2e9f8b0e3a7592702fa4358fb9103b93a26dd6bb92c2be0327ac054f14becc",
    "userSecret": "DSv56dS/PB7QGJI/IGX4qKDhGVhIvQQhWo4zxTDT0gn079JlHnUSSq8NAtavX4fpHj7PGQ74BzVXBO9pFHXdSeLCMnayKLTLD0+zmMu7wfGzy+ZhkYTBe040CXWQ+AYaPhGTzfVWu3Lz6oM2QnqM9X56BbvpC80tN8Zg72VJHWC6YjazdQQ2NK0pl9+ePbmqn7PNjFKLhipgpTl7Hw3kvnLrSIC9AcXzVYQeSWYAv3LAEbECB1aNLXC0glMG2W7L2iLTMwy54wHbXXfSQlK9S6X7wmnZ0tn28H0MwMqWdLLtxvcFyYlMr3E0hqYnK4a5sU0IvF1yJAMHMBCbjw2Trnx2VMuX5IWjdxScfh+8IxWGvKl6RypksJTyNg100H+Q+j0vfKW/bOijFolZgHJtAxUowPlewK9JwoWahkbX2KTGoqQbSCh6KSzaCxdbg7ykNI5n+m6vdoWzGfZGFYjfgMX6aMInAM3b32ZAp9DlfFxRkg3oeoLBuTGTz73E51bZj9mGgD0FxkIXFPIWGx0WyxoYpMEesJeT8phNy0G82Bd7qzWCPGP4gK70jGpqfCWsvj1XZKMMMjReCdUrhtXKB4spQIFi+63WcGV7vDyWQdUTINOhmR8QfZOJoVm+VZgFiqCLI3Aa8AnoYw3UIPiheVjE5lxMulPNIP0QGMR31VY="
}

Response

📘
Note
Your responses may differ from those listed below on a case-by-case basis.

Parameter	Type	Description
operationID	`String`	Unique ID generated to identify a specific operation.
success	`Boolean`	Returns `true` if request is successful and `false` for all else.
status	`Enum`	The status of the operation. `done` - Operation Completed `failed` - Operation Failed `user_input_required` - Pending User Input `initialized` - Operation In Progress *For further explanation see Operation Statuses
type	`Enum`	Type of error encountered Is only returned if the request was not successful
msg	`String`	Detailed description of the error Is only returned if the request was not successful
identity	`Object<Identity>`	An object containing the identity data of the user

Identity Schema

Parameter	Type	Description
nationality	`String`	User's nationality as reported by the financial institution.
dateOfBirth	`Date`	User's date (in YYYY-MM-DD format) of birth as reported by the financial institution.
emailAddress	`String`	User's email address as reported by the financial institution.
name	`String`	User's full name as reported by the financial institution.
numbers	`Array<Numbers>`	Array of user's phone numbers as provided by the financial institution.
identification	`Array<Identification>`	Array of user's identification information as provided by the bank.
address	`Object<Address>`	Object containing user's address information.

Numbers Schema

Parameter	Type	Description
type	`Enum`	The type of number. `mobile` `home` `office` `fax`
value	`String`	The user's number as provided by the financial institution.

Identification Schema

Parameter	Type	Description
type	`Enum`	Type of document. `passport` `national_id` `visa_number`
value	`String`	User's document number as provided by the financial institution.

Address Schema

Parameter	Type	Description
flat	`String`	User's flat as provided by the financial institution.
building	`String`	User's building as provided by the financial institution.
full	`String`	User's full address as provided by the financial institution.
area	`String`	User's area as provided by the financial institution.
poBox	`String`	User's PO box as provided by the financial institution.
city	`String`	User's city as provided by the financial institution.
state	`String`	User's state as provided by the financial institution.
country	`String`	User's country as provided by the financial institution.

Response Example

{
    "operationID": "3aea7906-7f7c-40af-ada7-3589f4b0ee2c",
    "success": true,
    "status": "done",
    "identity": {
        "nationality": null,
        "dateOfBirth": null,
        "identification": [
            {
                "type": "passport",
                "value": "AB656565"
            },
            {
                "type": "national_id",
                "value": "123456789"
            }
        ],
        "numbers": [
            {
                "type": "mobile",
                "value": "971521233445"
            }
        ],
        "emailAddress": "[email protected]",
        "name": "JOE DOE",
        "address": {
            "full": "90210, DAPI TOWER, DAPI ISLAND, ABU DHABI,",
            "flat": "0101",
            "building": "DAPI TOWER",
            "area": "DAPI ISLAND,",
            "poBox": null,
            "city": "ABU DHABI",
            "state": "ABU DHABI",
            "country": "AE"
        }
    }
}

Successful Request / Response

Successful Request

{
    "appSecret": "00bae841ad979345fca2e2585c000da7eac420504d189cf63315e7a6234d45c68dbd6fff749167292cd1475622805dce7a2b979db3c16e25a2897158ee63845b1043930ff603e19deb1d2d54ad9afc3d52df241d3c4e7286244a2f98a10212e38b2e9f8b0e3a7592702fa4358fb9103b93a26dd6bb92c2be0327ac054f14becc",
    "userSecret": "DSv56dS/PB7QGJI/IGX4qKDhGVhIvQQhWo4zxTDT0gn079JlHnUSSq8NAtavX4fpHj7PGQ74BzVXBO9pFHXdSeLCMnayKLTLD0+zmMu7wfGzy+ZhkYTBe040CXWQ+AYaPhGTzfVWu3Lz6oM2QnqM9X56BbvpC80tN8Zg72VJHWC6YjazdQQ2NK0pl9+ePbmqn7PNjFKLhipgpTl7Hw3kvnLrSIC9AcXzVYQeSWYAv3LAEbECB1aNLXC0glMG2W7L2iLTMwy54wHbXXfSQlK9S6X7wmnZ0tn28H0MwMqWdLLtxvcFyYlMr3E0hqYnK4a5sU0IvF1yJAMHMBCbjw2Trnx2VMuX5IWjdxScfh+8IxWGvKl6RypksJTyNg100H+Q+j0vfKW/bOijFolZgHJtAxUowPlewK9JwoWahkbX2KTGoqQbSCh6KSzaCxdbg7ykNI5n+m6vdoWzGfZGFYjfgMX6aMInAM3b32ZAp9DlfFxRkg3oeoLBuTGTz73E51bZj9mGgD0FxkIXFPIWGx0WyxoYpMEesJeT8phNy0G82Bd7qzWCPGP4gK70jGpqfCWsvj1XZKMMMjReCdUrhtXKB4spQIFi+63WcGV7vDyWQdUTINOhmR8QfZOJoVm+VZgFiqCLI3Aa8AnoYw3UIPiheVjE5lxMulPNIP0QGMR31VY="
}

Successful Response

{
    "operationID": "3aea7906-7f7c-40af-ada7-3589f4b0ee2c",
    "success": true,
    "status": "done",
    "identity": {
        "nationality": null,
        "dateOfBirth": null,
        "identification": [
            {
                "type": "passport",
                "value": "AB656565"
            },
            {
                "type": "national_id",
                "value": "123456789"
            }
        ],
        "numbers": [
            {
                "type": "mobile",
                "value": "971521233445"
            }
        ],
        "emailAddress": "[email protected]",
        "name": "JOE DOE",
        "address": {
            "full": "90210, DAPI TOWER, DAPI ISLAND, ABU DHABI,",
            "flat": "0101",
            "building": "DAPI TOWER",
            "area": "DAPI ISLAND,",
            "poBox": null,
            "city": "ABU DHABI",
            "state": "ABU DHABI",
            "country": "AE"
        }
    }
}

Successful Request / Response - When User Input Is Required

Successful Request - When User Input Is Required

{
    "appSecret": "00bae841ad979345fca2e2585c000da7eac420504d189cf63315e7a6234d45c68dbd6fff749167292cd1475622805dce7a2b979db3c16e25a2897158ee63845b1043930ff603e19deb1d2d54ad9afc3d52df241d3c4e7286244a2f98a10212e38b2e9f8b0e3a7592702fa4358fb9103b93a26dd6bb92c2be0327ac054f14becc",
    "userSecret": "DSv56dS/PB7QGJI/IGX4qKDhGVhIvQQhWo4zxTDT0gn079JlHnUSSq8NAtavX4fpHj7PGQ74BzVXBO9pFHXdSeLCMnayKLTLD0+zmMu7wfGzy+ZhkYTBe040CXWQ+AYaPhGTzfVWu3Lz6oM2QnqM9X56BbvpC80tN8Zg72VJHWC6YjazdQQ2NK0pl9+ePbmqn7PNjFKLhipgpTl7Hw3kvnLrSIC9AcXzVYQeSWYAv3LAEbECB1aNLXC0glMG2W7L2iLTMwy54wHbXXfSQlK9S6X7wmnZ0tn28H0MwMqWdLLtxvcFyYlMr3E0hqYnK4a5sU0IvF1yJAMHMBCbjw2Trnx2VMuX5IWjdxScfh+8IxWGvKl6RypksJTyNg100H+Q+j0vfKW/bOijFolZgHJtAxUowPlewK9JwoWahkbX2KTGoqQbSCh6KSzaCxdbg7ykNI5n+m6vdoWzGfZGFYjfgMX6aMInAM3b32ZAp9DlfFxRkg3oeoLBuTGTz73E51bZj9mGgD0FxkIXFPIWGx0WyxoYpMEesJeT8phNy0G82Bd7qzWCPGP4gK70jGpqfCWsvj1XZKMMMjReCdUrhtXKB4spQIFi+63WcGV7vDyWQdUTINOhmR8QfZOJoVm+VZgFiqCLI3Aa8AnoYw3UIPiheVjE5lxMulPNIP0QGMR31VY="
}

Response - When User Input Is Required

{
    "operationID": "47204fa6-dca6-44a5-8111-6c6489a232a2",
    "success": true,
    "status": "user_input_required",
    "userInputs": [
    {
      "answer": "",
      "id": "otp",
      "index": 0,
      "query": "Please enter a Smart Pass Token from your ENBD mobile application"
    }
    ]
}

Failed Request / Response - When Invalid JSON is Provided

Failed Request - When Invalid JSON is Provided

{
    "appSecret": "00bae841ad979345fca2e2585c000da7eac420504d189cf63315e7a6234d45c68dbd6fff749167292cd1475622805dce7a2b979db3c16e25a2897158ee63845b1043930ff603e19deb1d2d54ad9afc3d52df241d3c4e7286244a2f98a10212e38b2e9f8b0e3a7592702fa4358fb9103b93a26dd6bb92c2be0327ac054f14becc",
    "userSecret": "DSv56dS/PB7QGJI/IGX4qKDhGVhIvQQhWo4zxTDT0gn079JlHnUSSq8NAtavX4fpHj7PGQ74BzVXBO9pFHXdSeLCMnayKLTLD0+zmMu7wfGzy+ZhkYTBe040CXWQ+AYaPhGTzfVWu3Lz6oM2QnqM9X56BbvpC80tN8Zg72VJHWC6YjazdQQ2NK0pl9+ePbmqn7PNjFKLhipgpTl7Hw3kvnLrSIC9AcXzVYQeSWYAv3LAEbECB1aNLXC0glMG2W7L2iLTMwy54wHbXXfSQlK9S6X7wmnZ0tn28H0MwMqWdLLtxvcFyYlMr3E0hqYnK4a5sU0IvF1yJAMHMBCbjw2Trnx2VMuX5IWjdxScfh+8IxWGvKl6RypksJTyNg100H+Q+j0vfKW/bOijFolZgHJtAxUowPlewK9JwoWahkbX2KTGoqQbSCh6KSzaCxdbg7ykNI5n+m6vdoWzGfZGFYjfgMX6aMInAM3b32ZAp9DlfFxRkg3oeoLBuTGTz73E51bZj9mGgD0FxkIXFPIWGx0WyxoYpMEesJeT8phNy0G82Bd7qzWCPGP4gK70jGpqfCWsvj1XZKMMMjReCdUrhtXKB4spQIFi+63WcGV7vDyWQdUTINOhmR8QfZOJoVm+VZgFiqCLI3Aa8AnoYw3UIPiheVjE5lxMulPNIP0QGMR31VY="
}

Error

{
  "msg": "Invalid JSON request",
  "type": "BAD_REQUEST",
  "success": false,
  "status": "failed"
}

📘
Note
For more information and detailed breakdown of possible errors, please see Errors.

Get Identity

📘
Note

👍
Pre-Requirement

Request

Headers

Body Parameters

Request Example

Response

📘
Note

Identity Schema

Numbers Schema

Identification Schema

Address Schema

Response Example

Successful Request / Response

Successful Request

Successful Response

Successful Request / Response - When User Input Is Required

Successful Request - When User Input Is Required

Response - When User Input Is Required

Failed Request / Response - When Invalid JSON is Provided

Failed Request - When Invalid JSON is Provided

Error

📘
Note

📘Note

👍Pre-Requirement

Request

Headers

Body Parameters

Request Example

Response

📘Note

Identity Schema

Numbers Schema

Identification Schema

Address Schema

Response Example

Successful Request / Response

Successful Request

Successful Response

Successful Request / Response - When User Input Is Required

Successful Request - When User Input Is Required

Response - When User Input Is Required

Failed Request / Response - When Invalid JSON is Provided

Failed Request - When Invalid JSON is Provided

Error

📘Note

📘
Note

👍
Pre-Requirement

📘
Note

📘
Note