Identity Data

The /identity/get endpoint returns all account holder information on file with the data source including names, emails, phone numbers and addresses. Use your Access_token to fetch the data that is behind the connected account.

Sample Identity Data

{
  "source_name": "string",
  "source_type": "Electricity",
  "source_country": "string",
  "accounts": [
    {
      "account_number": "string",
      "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_number": "string",
      "owners": [
        {
          "sex": "Male",
          "social_security_number": "string",
          "birth_date": "2024-04-30",
          "names": [
            "string"
          ],
          "emails": [
            {
              "email": "string",
              "type": "Primary",
              "isPrimary": true
            }
          ],
          "phone_numbers": [
            {
              "phone": "string",
              "type": "Home",
              "isPrimary": true
            }
          ],
          "addresses": [
            {
              "city": "string",
              "countryCode": "string",
              "countryName": "string",
              "postal_code": "string",
              "state": "string",
              "streetLine1": "string",
              "streetLine2": "string",
              "recipient": "string",
              "type": "Billing"
            }
          ]
        }
      ]
    }
  ]
}

Refer to the API reference section for more details.

FieldDescription
source_nameThe name of the source providing the identity. Can be an Electric Provider, a Telecom company, A government database.
souce_typeThe type of the source as classified by Deck
source_countryThe country in which the source is operational
account_numberThe unique number assigned by the source to the account, which we are using for identification. For eg, the account number provided by an Electric Provider
account_idThe unique number assigned to the account by Deck
user_numberThe unique identifier of the Individual, provided by the
sexThe Sex of the individual being identified, as made available by the source
social_security_numberThe Social Security number of the individual, if made available by the source
birth_dateThe date of birth of the individual who's identity is being verified
namesThe name of the individual
emailThe email ID as made available by the source
phone_numberThe phone number of the indidiviudal as made available by the source
addressThe address of the individual as made available by the source