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

# Get account information

> Returns the verified account information record.

This is a server-to-server read for your backend — the record is personal data and never
reaches the browser. `{id}` is the account information ID carried in the `ais.completed`
event.

The record is available for the tenant's configured retention window (15 days by default),
after which it is redacted to attempt metadata.



## OpenAPI

````yaml /platform/services/account-information/openapi.yaml get /api/services/account-information/{id}
openapi: 3.1.0
info:
  title: Account Information API
  description: >-
    Verify a shopper's bank account — ownership, holder name, and account
    identifiers — through the Hellgate Cloud Platform Account Information
    Service. Create a session, drive the shopper through the bank login with the
    Web SDK, and receive the verified record on your backend.
  version: '1.0'
  contact:
    name: Starfish GmbH & Co. KG
    email: hello@starfish.team
    url: https://hellgate.io
  license:
    name: Hellgate API Terms
    url: https://hellgate.io/terms-and-conditions
servers:
  - url: https://api.eu1.hellgate.cloud
    description: EU1 environment
security:
  - bearerAuth: []
tags:
  - name: Account Information
    description: Create account-check sessions and retrieve the verified record.
  - name: Webhooks
    description: Register an endpoint and receive account-check event notifications.
paths:
  /api/services/account-information/{id}:
    get:
      tags:
        - Account Information
      summary: Get account information
      description: >-
        Returns the verified account information record.


        This is a server-to-server read for your backend — the record is
        personal data and never

        reaches the browser. `{id}` is the account information ID carried in the
        `ais.completed`

        event.


        The record is available for the tenant's configured retention window (15
        days by default),

        after which it is redacted to attempt metadata.
      operationId: getAccountInformation
      parameters:
        - name: id
          in: path
          required: true
          description: The account information ID from the completed event.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The account information record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountInformation'
        '401':
          description: The access token is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: >-
            No record matches the supplied ID for this tenant, or it has been
            redacted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AccountInformation:
      type: object
      description: >-
        The verified account information record. An account check returns
        exactly one financial institution and one account. Some fields are
        market-dependent.
      required:
        - id
        - created_at
        - data
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
        created_at:
          type: string
          format: date-time
          example: '2026-06-22T09:59:56Z'
        data:
          type: array
          items:
            type: object
            required:
              - financial_institution
              - user_identity
              - accounts
            properties:
              financial_institution:
                type: string
                example: Demo Bank
              user_identity:
                type: object
                properties:
                  full_name:
                    type: string
                    example: John Doe
                  date_of_birth:
                    type: string
                    description: ISO 8601 date (YYYY-MM-DD). Market-dependent.
                    example: '1976-01-01'
                  social_security_number:
                    type: string
                    description: Market-dependent.
                    example: '197601011234'
                  emails:
                    type: array
                    items:
                      type: object
                      required:
                        - address
                        - type
                      properties:
                        address:
                          type: string
                        type:
                          type: string
                          enum:
                            - primary
                            - secondary
                            - other
                            - unknown
                  addresses:
                    type: array
                    items:
                      type: object
                      required:
                        - type
                        - street
                        - postal_code
                        - city
                      properties:
                        type:
                          type: string
                          enum:
                            - business
                            - correspondence
                            - delivery_to
                            - mail_to
                            - po_box
                            - postal
                            - residential
                            - statement
                            - unknown
                        street:
                          type: string
                        postal_code:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        country_code:
                          type: string
                          description: ISO 3166-2 country code.
                  phone_numbers:
                    type: array
                    items:
                      type: object
                      required:
                        - number
                        - type
                      properties:
                        number:
                          type: string
                        type:
                          type: string
                          enum:
                            - home
                            - work
                            - mobile
                            - other
                            - unknown
              accounts:
                type: array
                items:
                  type: object
                  required:
                    - id
                    - name
                    - account_number
                    - account_type
                    - currency_code
                    - identifiers
                    - parties
                  properties:
                    id:
                      type: string
                      description: The provider's identifier for the bank account.
                      example: ee7ddbd178494220bb184791783f4f63
                    name:
                      type: string
                      description: >-
                        The name the shopper typically recognises the account
                        by.
                      example: Personal account
                    account_number:
                      type: string
                      example: DE69370400440532013000
                    account_type:
                      type: string
                      enum:
                        - checking
                        - savings
                      example: checking
                    currency_code:
                      type: string
                      description: ISO 4217 code.
                      example: EUR
                    identifiers:
                      type: object
                      properties:
                        ach:
                          type: object
                          required:
                            - account_number
                            - routing_number
                          properties:
                            account_number:
                              type: string
                            routing_number:
                              type: string
                        bacs:
                          type: object
                          required:
                            - account_number
                            - sort_code
                          properties:
                            account_number:
                              type: string
                            sort_code:
                              type: string
                        iban:
                          type: object
                          required:
                            - bban
                            - iban
                          properties:
                            bban:
                              type: string
                              description: Country-specific account number.
                            bic:
                              type: string
                            iban:
                              type: string
                    segment:
                      type: string
                      enum:
                        - business
                        - personal
                        - unknown
                    parties:
                      type: array
                      items:
                        type: object
                        required:
                          - identity
                          - role
                        properties:
                          identity:
                            type: object
                            properties:
                              name:
                                type: string
                              social_security_number:
                                type: string
                          role:
                            type: string
                            enum:
                              - holder
                              - authorised_user
                              - other
                              - unknown
      example:
        id: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d
        created_at: '2026-06-22T09:59:56Z'
        data:
          - financial_institution: Demo Bank
            user_identity:
              full_name: John Doe
              date_of_birth: '1976-01-01'
              social_security_number: '197601011234'
            accounts:
              - id: ee7ddbd178494220bb184791783f4f63
                name: Personal account
                account_number: DE69370400440532013000
                account_type: checking
                currency_code: EUR
                identifiers:
                  iban:
                    iban: DE69370400440532013000
                    bban: '370400440532013000'
                    bic: COBADEFFXXX
                parties:
                  - identity:
                      name: John Doe
                    role: holder
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: A machine-readable error code.
          example: tenant_not_enabled
        message:
          type: string
          description: A human-readable description of the error.
          example: The Account Information Service is not enabled for this tenant.
      example:
        code: tenant_not_enabled
        message: The Account Information Service is not enabled for this tenant.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        An Account Information–scoped OAuth2 access token obtained from the
        platform Authentication API. Send it as a bearer token on every request.

````