List All VSync States

Use this endpoint to list all VSync states for PIX key types with optional filters. Returns empty array [] if no VSync states match the criteria. Note: This table has at most 5 records (one per PIX key type: CPF, CNPJ, EMAIL, PHONE, EVP).

GET /v1/dict/vsync

List All VSync States

cURL

curl --request GET \
  --url https://api.example.com/v1/dict/vsync \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": "0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b",
      "keyType": "CPF",
      "lastSyncStatus": "SYNCED",
      "localVSync": "0000000000000000000000000000000000000000000000000000000000000000",
      "updatedAt": "2024-01-15T10:30:00Z",
      "lastCidCreatedAt": "2024-01-15T10:30:00Z",
      "lastFullReconciliation": "2024-01-15T10:30:00Z",
      "lastSyncCheck": "2024-01-15T10:30:00Z",
      "lastSyncTimestamp": "2024-01-15T10:30:00Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 5
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

page · integer<int64> · predeterminado: 1

Page number for pagination (default: 1, minimum: 1)

limit · integer<int64> · predeterminado: 5

Maximum number of items per page (default: 5, range: 1-100)

key_type · string

Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP

status · string[]

Filter by sync status (comma-separated, OR-matched): SYNCED, OUT_OF_SYNC, RECONCILING, ERROR

sort_order · string

Sort direction: asc or desc (default: asc)

Respuesta

200

application/json

OK

items · object[] · requerido

Array of VSync states for the current page

Show child attributes

limit · integer<int64> · requerido

Number of items per page

Ejemplo:

10

page · integer<int64> · requerido

Current page number

Ejemplo:

1

total · integer<int64> · requerido

Total number of VSync states matching the filters

Ejemplo:

5