Skip to main content
GET
/
v1
/
dict-keys
List PIX Keys
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/dict-keys \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "key_type": "cpf",
    "key_value": "<string>",
    "claim": {
      "claim_type": "portability",
      "id": 123,
      "ispb": "<string>",
      "resolution_deadline": "2023-11-07T05:31:56Z",
      "role": "claimer",
      "status": "pending_user_confirmation",
      "completion_deadline": "2023-11-07T05:31:56Z"
    }
  }
]

Authorizations

​
x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Response

List of DICT keys

​
created_at
string<date-time>
required
​
key_type
enum<string>
required
Available options:
cpf,
cnpj,
email,
phone,
evp
​
key_value
string
required
​
claim
object