Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Lista portabilidades ou reivindicações com paginação

get/dict/claims/list

Headers

isDonorboolean

True / False. Campo obrigatório. Indica se o usuário é um doador. Se não for fornecido, será considerado nulo.

isClaimerboolean

True / False. Indica se o usuário é um reivindicador. Se não for fornecido, será considerado nulo.

statusstring

O status da reivindicação. Pode ser: - 'OPEN': Reivindicação aberta. - 'WAITING_RESOLUTION': Reivindicação aguardando resolução. - 'CONFIRMED': Reivindicação confirmada. - 'CANCELLED': Reivindicação cancelada. - 'COMPLETED': Reivindicação concluída.

typestring

O tipo de reivindicação. Pode ser: - 'PORTABILITY': Reivindicação de portabilidade. - 'OWNERSHIP': Reivindicação de propriedade.

dateHourChangeStartstring date

Data e hora de início da mudança, no formato RFC 3339 (aaaa-MM-ddTHH:mm:ss.SSSZ).

dateHourChangeEndstring date

Data e hora de fim da mudança, no formato RFC 3339 (aaaa-MM-ddTHH:mm:ss.SSSZ).

pageSizeinteger

Tamanho da página para a paginação. Se não for fornecido, o padrão será 10.

pageinteger

Número da página para a paginação. Se não for fornecido, o padrão será 1.

Request body

{"stackTrail":"paths:/dict/claims/list:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

versionstring
statusinteger

Example response

{
  "version": "string",
  "body": {
    "items": [
      {
        "type": "PORTABILITY",
        "participationFlow": "DONOR",
        "key": "string",
        "keyType": "CPF",
        "claimerAccount": {
          "participant": "string",
          "branch": "string",
          "accountNumber": "string",
          "accountType": "CACC",
          "openingDate": "2024-05-29T13:58:46.313Z"
        },
        "claimer": {
          "type": "NATURAL_PERSON",
          "taxIdNumber": "string",
          "name": "string",
          "tradeName": "string"
        },
        "donorAccount": {
          "participant": "string",
          "branch": "string",
          "accountNumber": "string",
          "accountType": "CACC",
          "openingDate": "2024-05-29T13:58:46.313Z"
        },
        "donor": {
          "type": "NATURAL_PERSON",
          "taxIdNumber": "string",
          "name": "string",
          "tradeName": "string"
        },
        "donorParticipant": "string",
        "id": "string",
        "status": "OPEN",
        "completionPeriodEnd": "2024-05-29T13:58:46.313Z",
        "resolutionPeriodEnd": "2024-05-29T13:58:46.313Z",
        "lastModified": "2024-05-29T13:58:46.313Z",
        "confirmReason": "USER_REQUESTED",
        "cancelReason": "USER_REQUESTED",
        "cancelledBy": "DONOR"
      }
    ],
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}