Skip to main content
GET
List PIX key claims

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

account_id
string
required

The CRM account id whose claims to list.

Example:

"acc-123"

status
string

Set to 'processing' to list in-flight claims as key entries instead of claims.

Example:

"processing"

ispb
string

The ISPB of the direct participant whose directory answers. This deployment may act as SEVERAL direct SPI participants - one ISPB each, each with its own customers and its own DICT credential - and this field is the only thing on the request that says which of them is read. OPTIONAL while it acts as a single participant: omit it and that one answers. REQUIRED once it acts as several - omitted is 422 PIX-0127, and an ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply and guarantee, exactly like payerIspb on a transaction: never a credential, never read from a header or a path, and it never widens what your token can reach. Read the participant that holds the keys, or the listing comes back empty for an account that has them. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9]{8}$
Example:

"12345678"

Response

OK

claims
object[] | null

The list of claims (default branch).

data
object[] | null

The in-flight claims as key entries (?status=processing branch).