---
title: "Get account lookup by status"
method: GET
path: "/account_lookups"
tags: ["Beneficiary confirmation"]
---

# Get account lookup by status

`GET /account_lookups`

Get Account Lookup entities by status and other filters. Status defaults to `REQUESTED`.

## Query parameters

- `page` integer
- `size` integer
- `account_lookup_status` AccountLookupStatus[]
- `start-date` string
- `end-date` string
- `sort_field` 'CREATED_DATE' | 'LAST_MODIFIED_DATE'
- `sort_direction` 'ASC' | 'DESC'

## Response `200`

Successfully returned response for Account Lookup

- AccountLookups — Paged response for account lookups
  - `first` boolean — true if this is the first page.
  - `last` boolean — true if this is the last page.
  - `number` integer — page number
  - `numberOfElements` integer — Number Of elements in this request
  - `size` integer — page size
  - `totalElements` integer — Total number of elements for the given request
  - `totalPages` integer — Total number of pages for the given request
  - `sort` Sort[] — Sort details of this page
    - `direction` string — Direction of the sort
    - `property` string
    - `ignoreCase` boolean
    - `nullHandling` string
    - `ascending` boolean
    - `descending` boolean
  - `content` AccountLookup[]
    - `account_lookup_id` string, uuid, required — UUID that links Account lookup request and response.
    - `account_lookup_status` 'REQUESTED' | 'PROCESSED' | 'FAILED' | 'EXPIRED', required — State of the Account Lookup object. Should be `REQUESTED`/`PROCESSED`/`FAILED`.
    - `first_name` string — First name of the beneficiary.
    - `middle_name` string — Middle name of the beneficiary.
    - `last_name` string — Last name of the beneficiary.
    - `org_name` string — Name of the organization.
    - `country_code` string — Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.
    - `account_currency` string — The 3 character currency code for the account as per ISO-4217 standards
    - `account_id` string — Identifier for the Account, e.g account number.
    - `account_id_type` 'AIIN' | 'BBAN' | 'CARD' | 'CUID' | 'UPIC' | 'EMAIL' | 'MSISDN' | 'DMST' | 'OTHER' — Account ID type. Possible values are - `AIIN` - (default) Account Issue Identification Number - `BBAN` - Basic Bank Account Number - `CARD` - PAN of the card identifying the account - `CUID` - CHIPS Universal Identifier - `UPIC` - Universal Payment Identification Code - `EMail` - Email Address - `MSISDN` - Mobile Subscriber Integrated Service Digital Network (i.e., phone number) - `DMST` - Domestic - `Other` - Other identifier (e.g., PayID)
    - `result_code` string — Result code of the Account Lookup response. Possible values are - `RNCB0000` - Pass- Name and Identifier are correct and linked - `RNCB0001` - Fail- Name and Identifier not found - `RNCB0002` - Fail- Name and Identifier do not match
    - `result_status` 'PASS' | 'FAIL' — Result status of Account Lookup response.
    - `result_description` string — Result description of Account Lookup response.
    - `redacted_first_name` string — First name of the beneficiary redacted by the receiver.
    - `redacted_middle_name` string — Middle name of the beneficiary redacted by the receiver.
    - `redacted_last_name` string — Last name of the beneficiary redacted by the receiver.
    - `redacted_org_name` string — Name of the organization redacted by the receiver.
    - `redacted_country_code` string — Country of the beneficiary redacted by the receiver.
    - `redacted_account_id` string — Identifier for the Account, e.g account number, redacted by the receiver.
    - `redacted_account_id_type` 'AIIN' | 'BBAN' | 'CARD' | 'CUID' | 'UPIC' | 'EMAIL' | 'MSISDN' | 'DMST' | 'OTHER' — Account ID type, redacted by the receiver. Possible values are - `AIIN` - (default) Account Issue Identification Number - `BBAN` - Basic Bank Account Number - `CARD` - PAN of the card identifying the account - `CUID` - CHIPS Universal Identifier - `UPIC` - Universal Payment Identification Code - `EMail` - Email Address - `MSISDN` - Mobile Subscriber Integrated Service Digital Network (i.e., phone number) - `DMST` - Domestic - `Other` - Other identifier (e.g., PayID)
    - `redacted_account_currency` string — The 3 character currency code for the account as per ISO-4217 standards
    - `clearing_system_code` string — Clearing system code
    - `branch_code` string — The Branch code (e.g., routing code) that the receiver has on their system.

## Other responses

- `400` — Bad request problem
- `404` — Account Lookup Not Found
- `500` — Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.

---

[API](https://skmtc.net/ripple/apis/ripplenet-server-api.md) · [All operations](https://skmtc.net/ripple/apis/ripplenet-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripplenet-server-api/versions/7843f07ca150/schema)