> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Criar chave > Registra uma nova chave PIX para uma conta. Especifique o tipo de chave (keyType: 0=CPF, 1=CNPJ, 2=EMAIL, 3=PHONE, 4=EVP). Para EVP (tipo 4), o valor da chave e gerado automaticamente e pode ser omitido. A resposta retorna o status numerico da chave (0=FINALIZED/aguardando confirmacao, 1=ACTIVE, etc.). ## OpenAPI ````yaml pt/openapi/v3-current/pix.yaml POST /v1/entries openapi: 3.0.3 info: title: Plugin BR Pix Direct - API Completa description: > API completa para o sistema de pagamentos instantaneos PIX brasileiro, incluindo operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes, transacoes e limites de transacao. version: 1.0.0 servers: - url: https://plugin-pix-direct.api.lerian.net - url: https://plugin-pix-direct-qrcode.api.lerian.net security: - bearerAuth: [] paths: /v1/entries: post: tags: - API de Chaves DICT summary: Criar chave description: > Registra uma nova chave PIX para uma conta. Especifique o tipo de chave (keyType: 0=CPF, 1=CNPJ, 2=EMAIL, 3=PHONE, 4=EVP). Para EVP (tipo 4), o valor da chave e gerado automaticamente e pode ser omitido. A resposta retorna o status numerico da chave (0=FINALIZED/aguardando confirmacao, 1=ACTIVE, etc.). requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePixKeyRequest' examples: phone_key: summary: Criar chave PIX de telefone (keyType 3) value: key: '+5511987654321' keyType: 3 accountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 isValidated: false email_key: summary: Criar chave PIX de email (keyType 2) value: key: user@example.com keyType: 2 accountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 isValidated: false cpf_key: summary: Criar chave PIX de CPF (keyType 0) value: key: '12345678901' keyType: 0 accountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 isValidated: true evp_key: summary: Criar chave EVP aleatoria (keyType 4) value: keyType: 4 accountId: 019c96a0-0c0c-7221-8cf3-13313fb60081 isValidated: false responses: '201': description: Chave PIX criada com sucesso content: application/json: schema: $ref: '#/components/schemas/PixKeyResponse' example: key: '+5511987654321' keyType: 3 keyTypeDescription: keyType 3 = PHONE status: 0 statusDescription: FINALIZED statusComment: status 0 = FINALIZED/pending confirmation '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' components: schemas: CreatePixKeyRequest: type: object required: - keyType - accountId - isValidated properties: key: type: string description: > Valor da chave PIX (opcional para chaves EVP/aleatorias que sao geradas automaticamente). O formato depende do keyType: CPF (11 digitos), CNPJ (14 digitos), Email (email valido), Telefone (prefixo +55) ou omitir para EVP. example: '+5511987654321' keyType: $ref: '#/components/schemas/KeyTypeEnum' accountId: type: string format: uuid description: Identificador da conta. example: 019c96a0-0a98-7287-9a31-786e0809c769 isValidated: type: boolean description: 'Indica se a chave foi pre-validada (ex.: email/telefone verificado).' example: false PixKeyResponse: type: object required: - key - keyType - status - statusDescription properties: key: type: string description: Valor da chave PIX. example: '+5511987654321' keyType: $ref: '#/components/schemas/KeyTypeEnum' status: $ref: '#/components/schemas/KeyStatusEnum' statusDescription: type: string description: >- Descricao legivel do status correspondente ao codigo de status numerico. example: PENDING_CONFIRMATION KeyTypeEnum: type: integer description: > Identificador do tipo de chave PIX. Codigos numericos que especificam o tipo de chave PIX sendo utilizada. **Valores validos:** - `0` = CPF (CPF de pessoa fisica com 11 digitos, ex.: "12345678901") - `1` = CNPJ (CNPJ de pessoa juridica com 14 digitos, ex.: "12345678000190") - `2` = EMAIL (Endereco de email, ex.: "user@example.com") - `3` = PHONE (Numero de telefone em formato internacional, ex.: "+5511987654321") - `4` = EVP (Chave UUID aleatoria gerada automaticamente, ex.: "123e4567-e89b-12d3-a456-426614174000") enum: - 0 - 1 - 2 - 3 - 4 x-enum-varnames: - CPF - CNPJ - EMAIL - PHONE - EVP example: 3 KeyStatusEnum: type: integer description: > Codigo de status de registro da chave PIX. Indica o estado atual de uma chave PIX em seu ciclo de vida. **Valores validos:** - `-1` = CANCELLED (Registro da chave foi cancelado) - `0` = FINALIZED (Chave finalizada/aguardando confirmacao) - `1` = ACTIVE (Chave ativa e operacional) - `2` = WAITING_OWNERSHIP_CONFIRMATION (Aguardando confirmacao de propriedade do usuario) - `3` = CREATING (Chave esta sendo criada no sistema) - `4` = IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST (Sou reivindicador, aguardando confirmacao da reivindicacao) - `5` = IM_CLAIMER_PENDING_OWNER_GIVEWAY (Sou reivindicador, aguardando proprietario atual liberar a chave) - `6` = IM_OWNER_PENDING_GIVEAWAY_CONFIRM (Sou proprietario, aguardando aprovacao para transferir a chave) - `7` = IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM (Transferencia iniciada, aguardando minha confirmacao) enum: - -1 - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 x-enum-varnames: - CANCELLED - FINALIZED - ACTIVE - WAITING_OWNERSHIP_CONFIRMATION - CREATING - IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST - IM_CLAIMER_PENDING_OWNER_GIVEWAY - IM_OWNER_PENDING_GIVEAWAY_CONFIRM - IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM example: 1 ErrorResponse: type: object properties: code: type: string description: Codigo do erro message: type: string description: Mensagem de erro details: type: array items: type: string description: Detalhes adicionais do erro responses: BadRequest: description: Requisicao Invalida - Parametros invalidos content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_key_type: summary: Invalid key type value: code: INVALID_KEY_TYPE message: Key type must be between 0 and 4 details: - 'keyType: must be one of [0, 1, 2, 3, 4]' missing_required_field: summary: Missing required field value: code: VALIDATION_ERROR message: Required field is missing details: - 'accountId: field is required' invalid_document_format: summary: Invalid document format value: code: INVALID_DOCUMENT message: Document must be valid CPF (11 digits) or CNPJ (14 digits) details: - 'document: must match pattern ^\d{11}$|^\d{14}$' invalid_phone_format: summary: Invalid phone format value: code: INVALID_PHONE message: Phone must be in Brazilian format details: - 'phone: must match pattern ^\+55\d{2}\d{8,9}$' Unauthorized: description: Nao Autorizado - Autenticacao invalida ou ausente content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_token: summary: Missing authentication token value: code: MISSING_TOKEN message: Authorization header is required details: [] invalid_token: summary: Invalid token value: code: INVALID_TOKEN message: Invalid or expired access token details: [] expired_token: summary: Expired token value: code: TOKEN_EXPIRED message: Access token has expired. Please obtain a new token. details: [] InternalServerError: description: Erro Interno do Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: generic_error: summary: Generic internal error value: code: INTERNAL_ERROR message: An internal error occurred. Please try again later. details: [] database_error: summary: Database error value: code: DATABASE_ERROR message: Database operation failed details: [] external_service_error: summary: External service error value: code: EXTERNAL_SERVICE_ERROR message: External service (JD PIX) is temporarily unavailable details: [] securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Autenticacao por token JWT Bearer. Obtenha o token no endpoint `/v1/login/oauth/access_token` usando credenciais do cliente (clientId e clientSecret). Inclua o token no header Authorization: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` O token expira apos 3600 segundos (1 hora). ````