---
title: "Get identity"
method: GET
path: "/data/v2/identity"
tags: ["Identity Raw Data"]
---

# Get identity

`GET /data/v2/identity`

Get the identity details of the account holder stored at the bank. Requires the following permissions: `identity`. **A step by step guide** [here](https://docs.leantech.me/docs/lean-open-finance-data-integration-guide).

## Query parameters

- `async` boolean
- `page` integer
- `size` integer
- `entity_id` string, uuid
- `meta` string

## Response `200`

OK

- FetchIdentityV2Result
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required — The status of the request
  - `results_id` string, uuid, required — The unique identifier for the request
  - `message` string, required — A message describing the status of the request
  - `meta` object, nullable — Meta information about the request
  - `timestamp` string, date-time, required — The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable — Granular status code
    - `status_additional_info` string, nullable — Additional information about the status
  - `refreshed_at` string, date-time, nullable — The datetime of when the data was refreshed
  - `type` string, nullable — The endpoint the original request was made to.
  - `data` IdentityData
    - `account_id` string, uuid — Account ID
    - `type` string, required — The endpoint the original request was made to.
    - `identities` IdentityV2data[] — An array of identities associated with the Entity.
      - `entity_id` string, uuid — entity id
      - `full_legal_name` string — Full legal name as retrieved from bank
      - `name` string — Name of the account holder
      - `national_id` string — National ID number for the country
      - `birth_date` string, date — The date of birth of the account holder.
      - `gender` string — The gender of the account holder.
      - `email_address` string — The registered email address of the account holder.
      - `legal_structure` string — Legal structure of the entity
      - `phone` string — Phone number of the account holder
      - `mobile_number` string — Mobile number of the account holder
      - `address` Address — The full address details
        - `address_line` string — Full address line as retrieved from bank
        - `address_type` string — The type of address (e.g., residential, business).
        - `building_type` string — The type of building, apartments or villa for example.
        - `apartment_or_villa_number` string — The apartment or villa/house number.
        - `building_name` string — The name of the building.
        - `street` string — The street name.
        - `area` string — The area or neighborhood.
        - `street_address` string — Street address which may include house number, street name and PO Box
        - `post_code` string — The Zip or postal code associated with the address.
        - `town_name` string — The town or city name where the address is located.
        - `region` string — The region of the address. State, province, prefecture, or region
        - `po_box` string — The post office box number.
        - `country` string — The country where the address is located.
      - `account_role` string — Role of the account holder
      - `party_type` 'DELEGATE' | 'JOINT' | 'SOLE' | 'UNSUPPORTED' — Type of party relationship
      - `party_id` string — Unique identifier for the party
      - `party_number` string — Party number assigned by the institution
    - `page` PageMetadata — Metadata about the current page of results
      - `number` integer, required — The current page being returned by the API
      - `size` integer, required — The page size requested
      - `total_elements` integer, required — The total number of elements in all pages
      - `total_pages` integer, required — The total number of pages retrievable
      - `sort` string[] — Sort parameters applied to the results

## Other responses

- `202` — Accepted (Asynchronous request)
- `400` — Bad Request
- `404` — Entity not found
- `500` — Internal Server Error

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)