Create Pix Key

Request a new Pix key for a partner user.

Endpoint

POST /partner/v1/pix-key

Request

Headers

Name	Type	Required	Description
X-API-Key	string	Yes	Your partner API key
Content-Type	string	Yes	application/json

Body

Field	Type	Required	Description
document	string	Yes	User’s CPF (tax ID)
idempotency_key	string (UUID)	Yes	Unique key to prevent duplicate requests

{
  "document": "12345678900",
  "idempotency_key": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Success (202 Accepted)

The request was accepted and the Pix key creation is in progress.

{
  "status": "accepted"
}

Already exists (409 Conflict)

A Pix key already exists for this user.

{
  "status": "already_exists"
}

User not found (404 Not Found)

{
  "status": "user_not_found"
}

Invalid document (400 Bad Request)

{
  "status": "invalid_document"
}

Example

curl -X POST https://api.bipa.tech/partner/v1/pix-key \
  -H "X-API-Key: your_partner_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12345678900",
    "idempotency_key": "550e8400-e29b-41d4-a716-446655440000"
  }'

Pix key creation is asynchronous. Monitor the Events endpoint for pix_key events to track the key registration status.