v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Claims

List key claims

List key DICT claims

get/v2/pix/claims

Query parameters

type'OWNERSHIP' | 'PORTABILITY'

Key claim type filter:

  • OWNERSHIP - Transfers key ownership between individuals in the same or another bank.
  • PORTABILITY- Transfers key ownership for the same individual to another bank.
status'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED'

Claim status filter

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

List claims

Example response

{
  "claims": [
    {
      "account_id": 6912345,
      "claim_id": "123e4567-e89b-12d3-a456-426655440000",
      "claim_type": "OWNERSHIP",
      "claimer": {
        "document_number": "7777888hh",
        "name": "Jerry Atrick",
        "trade_name": "Acme Widgets",
        "type": "OWNERSHIP"
      },
      "claimer_account": {
        "account_number": "98765432",
        "account_type": "TRAN",
        "opening_datetime": "2020-08-13T13:49:03Z",
        "participant": "00115678",
        "branch": "011"
      },
      "key": "email@email.com",
      "key_type": "EMAIL",
      "last_modified": "2020-08-13T13:49:03Z",
      "status": "OPEN",
      "creation_datetime": "2020-08-13T13:49:03Z",
      "resolution_period_end": "2020-01-17T10:00:00Z",
      "reason": "L",
      "completion_period_end": "2020-01-24T10:00:00Z"
    }
  ]
}