showPixKey

GET 
/api/pix/keys/:id

Shows the requested Pix key information

Request

Path Parameters

id stringrequired
Pix Key ID
Example: 7da0c9af-215e-4625-b484-b8cfc87aaa09

Responses

200

Ok

application/json

Schema

Schema

id id (string)

Pix Key id

type type (string)

Possible values: [CPF, CNPJ, EMAIL, PHONE, EVP]

Pix Key type

key key (string)

Pix Key

emv emv (string)

EMV related to the key

created_at created_at (string)

Date when the key was created

Example (from schema)

{
  "id": "649604ff-dd72-4c2c-8909-9d49dbbd1bde",
  "type": "EVP",
  "key": "32c32de0-50f7-4f4f-96d9-81d716e69864",
  "emv": "00020101021126330014br.gov.bcb.pix0111082853887515204000053039865406100.005802BR5912API DE TESTE6009SAO PAULO620605022163045927",
  "created_at": "2024-07-12T19:30:35.000000Z"
}

401

Unauthenticated

application/json

Schema

Schema

message message (integer)

Response 401

Example (from schema)

{
  "message": "Invalid x-api-key"
}

404

Not Found

500

Error

Loading...