> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.finverse.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get identity

> Retrieve all Identity information for a Login Identity (using a specific `login_identity_token`).

**Authorization**: `login_identity_token`

### identity

Full `identity` object, containing accountholder identity details (at a minimum: `names`) for the requested Login Identity.

#### addresses

Full `addresses` array, containing accountholder address information, as reported by the institution. Omitted if not available.

#### date_of_births

Full `date_of_births` array, containing accountholder information, as reported by the institution. Omitted if not available.

#### emails

Full `emails` array, containing accountholder email information, as reported by the institution. Omitted if not available.

#### names

Full `names` array, containing accountholder email information, as reported by the institution. Will always be returned for Institutions listed as supporting Finverse's Identity product.

#### phone_numbers

Full `phone_numbers` array, containing accountholder phone information, as reported by the institution. Omitted if not available.

### institution

Summary Institutions object. See `GET /institutions` for details.

### login_identity

Summary Login Identity object. See `GET /login_identity` for details.



## OpenAPI

````yaml /api-reference/openapi.json get /identity
openapi: 3.0.0
info:
  description: Documentation of the early finverse services
  title: Finverse Public
  termsOfService: https://example.com
  contact:
    name: Maintainers
    email: info@finverse.com
  license:
    name: unknown license
  version: 0.0.1
servers:
  - url: https://api.prod.finverse.net
security:
  - Oauth2:
      - test
tags:
  - name: public
    description: Publicly accessible endpoints
    x-group: Public
  - name: customer
    description: Customer app and institution endpoints
    x-group: Customer
  - name: link
    description: Finverse Link flows
    x-group: Link
  - name: login_identity
    description: Login identity lifecycle and metadata
    x-group: Login identity
  - name: accounts
    description: Accounts, balances, and account numbers
    x-group: Accounts
  - name: statements
    description: Statements and composite statements
    x-group: Statements
  - name: transactions
    description: Transaction history
    x-group: Transactions
  - name: identity_income
    description: Identity and income insights
    x-group: Identity & income
  - name: payment_links
    description: Payment link creation and checkout
    x-group: Payment links
  - name: mandates
    description: Direct debit mandates
    x-group: Mandates
  - name: payments
    description: Payment initiation and status
    x-group: Payment operations
  - name: payouts
    description: Payouts and scheduled payouts
    x-group: Payouts
  - name: payment_users
    description: Payment user profiles
    x-group: Payment users
  - name: payment_accounts
    description: Payment accounts for users
    x-group: Payment accounts
  - name: payment_methods
    description: Stored payment methods
    x-group: Payment methods
  - name: bills
    description: Bill presentment
    x-group: Bills
  - name: disputes
    description: Payment disputes
    x-group: Disputes
  - name: ledger
    description: Ledger and statements
    x-group: Ledger
paths:
  /identity:
    get:
      tags:
        - identity_income
      summary: Get identity
      description: >-
        Retrieve all Identity information for a Login Identity (using a specific
        `login_identity_token`).


        **Authorization**: `login_identity_token`


        ### identity


        Full `identity` object, containing accountholder identity details (at a
        minimum: `names`) for the requested Login Identity.


        #### addresses


        Full `addresses` array, containing accountholder address information, as
        reported by the institution. Omitted if not available.


        #### date_of_births


        Full `date_of_births` array, containing accountholder information, as
        reported by the institution. Omitted if not available.


        #### emails


        Full `emails` array, containing accountholder email information, as
        reported by the institution. Omitted if not available.


        #### names


        Full `names` array, containing accountholder email information, as
        reported by the institution. Will always be returned for Institutions
        listed as supporting Finverse's Identity product.


        #### phone_numbers


        Full `phone_numbers` array, containing accountholder phone information,
        as reported by the institution. Omitted if not available.


        ### institution


        Summary Institutions object. See `GET /institutions` for details.


        ### login_identity


        Summary Login Identity object. See `GET /login_identity` for details.
      operationId: getIdentity
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIdentityResponse'
              examples:
                success:
                  summary: Success
                  value:
                    identity:
                      addresses:
                        - account_ids:
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                            - 01FXSPPEV1B1NH5XF063FC31VX
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                          full_address: 69 A Building 4, Example Street, Unicorn Land
                          raw: 69 A Building 4, Example Street, Unicorn Land
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ577NPJ115HXNH7V0KZ
                      date_of_births:
                        - account_ids:
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                            - 01FXSPPEV1B1NH5XF063FC31VX
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                          date_of_birth: '2006-09-01'
                          raw: '2006-09-01'
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ577NPJ115HXNH7V0KZ
                      emails:
                        - account_ids:
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                            - 01FXSPPEV1B1NH5XF063FC31VX
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                          email: test@mail.com
                          raw: test@mail.com
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ577NPJ115HXNH7V0KZ
                      names:
                        - account_ids:
                            - 01FXSPPEV1B1NH5XF063FC31VX
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                          full_name: John Doe
                          raw: John Doe
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ54716YSAECRPJBY8R1
                        - account_ids:
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                          full_name: Joe
                          raw: Joe
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ54716YSAECRPJBY8R1
                        - account_ids:
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                            - 01FXSPPEV1B1NH5XF063FC31VX
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                          full_name: User Good
                          raw: User Good
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ577NPJ115HXNH7V0KZ
                      phone_numbers:
                        - account_ids:
                            - 01FXSPPETNWRJ4Y3XVDXESJFEC
                            - 01FXSPPETRJ62KFG8CYJR2RAHV
                            - 01FXSPPETVE1R5PPBYJG9DWVYF
                            - 01FXSPPETY5HNFGEZZ7FK4E32X
                            - 01FXSPPEV1B1NH5XF063FC31VX
                          mobile_phone: '12344312'
                          raw: '12344312'
                          source: ONLINE_BANKING
                          source_ids:
                            - 01FXSPPQ577NPJ115HXNH7V0KZ
                    institution:
                      countries:
                        - HKG
                        - SGP
                        - PHL
                      institution_id: testbank
                      institution_name: TestBank HK
                      portal_name: Test Bank Personal Account
                    login_identity:
                      last_session_id: 01FXSPP54CB7PPAFGK5FZ2WBTV
                      login_identity_id: 01FXSPP53F7C3C110C4GSQJEWC
                      status: DATA_RETRIEVAL_COMPLETE
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestModelV2'
              examples:
                identity_unavailable:
                  summary: Error (Identity unavailable)
                  value:
                    error:
                      error_code: IDENTITY_UNAVAILABLE
                      message: >-
                        No identity information is associated with the requested
                        Login Identity. We may not be able to retrieve identity
                        for this user type, or there may have been an error
                        retrieving identity for this user (please review
                        product_status for details).
                      request_id: '{unique_id}'
                      type: API_ERROR
                product_not_supported:
                  summary: Error (product not supported)
                  value:
                    error:
                      code: 40012
                      details: Identity is not supported for this bank
                      error_code: PRODUCT_NOT_SUPPORTED
                      message: >-
                        Requested product is not yet supported for this
                        institution. Please refer to Institutions list for
                        details on products supported.
                      request_id: unique_id
                      type: API_ERROR
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestModelV2'
      security:
        - Oauth2:
            - identity
components:
  schemas:
    GetIdentityResponse:
      properties:
        identity:
          $ref: '#/components/schemas/Identity'
        institution:
          $ref: '#/components/schemas/InstitutionShort'
        login_identity:
          $ref: '#/components/schemas/LoginIdentityShort'
    BadRequestModelV2:
      properties:
        error:
          type: object
          required:
            - type
            - code
            - error_code
            - message
            - request_id
          properties:
            code:
              type: integer
              example: 40004
            details:
              type: string
            error_code:
              type: string
              example: CREDENTIALS_INVALID
            message:
              type: string
            request_id:
              description: The request_id provided in the request header
              type: string
            type:
              description: The error type
              type: string
              enum:
                - LINK_ERROR
                - API_ERROR
              example: LINKING_ERROR
    Identity:
      properties:
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/IdentityAddress'
          description: >-
            Accountholder's address, as reported by the institution (if
            available).
        date_of_births:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDateOfBirth'
          description: >-
            Accountholder's date of birth, as reported by the institution (if
            available).
        emails:
          type: array
          items:
            $ref: '#/components/schemas/IdentityEmail'
          description: >-
            Accountholder's email, as reported by the institution (if
            available).
        names:
          type: array
          items:
            $ref: '#/components/schemas/IdentityName'
          description: >-
            Accountholder's name, as reported by the institution. This will
            always be available for Institutions listed as supporting Finverse's
            Identity product.
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/IdentityPhoneNumber'
          description: >-
            Accountholder's phone numbers, as reported by the institution (if
            available).
    InstitutionShort:
      properties:
        countries:
          type: array
          items:
            type: string
          example:
            - HKG
        institution_id:
          type: string
          example: 123
        institution_name:
          type: string
          example: Mock Bank
        portal_name:
          type: string
          example: Personal Internet Banking
    LoginIdentityShort:
      properties:
        last_session_id:
          type: string
          format: ulid
        login_identity_id:
          type: string
          format: ulid
        status:
          type: string
          example: LINKING
    IdentityAddress:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
        building_name:
          type: string
          example: Building A
        city:
          type: string
          example: London
        country:
          type: string
          example: United Kingdom
        district:
          type: string
          example: Marleybone
        floor_number:
          type: string
          example: '2'
        full_address:
          type: string
          example: 221B Baker Street, Westminster, London
        postal_code:
          type: string
          example: NW1 6XE
        province:
          type: string
          example: Westminster
        raw:
          type: string
          example: 221B Baker Street, Westminster, London
        source:
          type: string
          example: INTERNET_BANKING
        source_ids:
          type: array
          items:
            type: string
        street_address:
          type: string
          example: 221B Baker Street
        street_name:
          type: string
          example: Baker Street
        street_number:
          type: string
          example: 221B
        unit_number:
          type: string
          example: 221B
        ward:
          type: string
          example: Sheung Wan
    IdentityDateOfBirth:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
        date_of_birth:
          type: string
          example: '1999-01-22'
        masked_date_of_birth:
          type: string
          example: XXXX-01-22
        raw:
          type: string
          example: '1999-01-22'
        source:
          type: string
          example: INTERNET_BANKING
        source_ids:
          type: array
          items:
            type: string
    IdentityEmail:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
        email:
          type: string
          example: example123@example.com
        masked_email:
          type: string
          example: exam******@example.com
        raw:
          type: string
          example: example123@example.com
        source:
          type: string
          example: INTERNET_BANKING
        source_ids:
          type: array
          items:
            type: string
    IdentityName:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
        first_name:
          type: string
          example: John
        full_name:
          type: string
          example: John Maximus Doe
        last_name:
          type: string
          example: Doe
        other_name:
          type: string
          example: Maximus
        raw:
          type: string
          example: John Maximus Doe
        source:
          type: string
          example: INTERNET_BANKING
        source_ids:
          type: array
          items:
            type: string
    IdentityPhoneNumber:
      type: object
      properties:
        account_ids:
          type: array
          items:
            type: string
        masked_phone:
          type: string
          example: +12345****01
        mobile_phone:
          type: string
          example: '+12345678901'
        other_phone:
          type: string
          example: '+12345678901'
        raw:
          type: string
          example: +123 4567 8901
        source:
          type: string
          example: INTERNET_BANKING
        source_ids:
          type: array
          items:
            type: string
  securitySchemes:
    Oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://finverse-dev.us.auth0.com/oauth/token
          scopes:
            account: Account
            balance: Balance
            credit: Credit
            institution: Institution
            investment: Investment
            link: Link
            test: Test
            transaction: Transaction

````