Get Pix Key

Retrieve a Pix key for a specific user document.

Endpoint

GET /partner/v1/pix-key/{document}

Request

Path parameters

Name	Type	Required	Description
document	string	Yes	User’s CPF (tax ID)

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key

Response

Success (200 OK)

{
  "pix_key": "abc123-def456-ghi789",
  "created_at": 1704067200
}

Field	Type	Description
pix_key	string	The EVP (random) Pix key
created_at	integer	Unix timestamp of key creation

Not found (404 Not Found)

No Pix key exists for the specified document.

Invalid document (400 Bad Request)

The provided document is not a valid CPF.

Example

curl https://api.bipa.tech/partner/v1/pix-key/12345678900 \
  -H "X-API-Key: your_partner_api_key"