> ## Documentation Index > Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt > Use this file to discover all available pages before exploring further. # 1 - Criar Chave Pix >

Scopes:

api.pix api.chave.criar Por meio deste endpoint, o parceiro pode registrar uma nova chave Pix, ampliando suas opções de recebimento. As opções de chave incluem: CPF/CNPJ, e-mail, número de celular ou uma chave aleatória. Para utilizar este endpoint é necessário realizar a dupla verificação através de MFA para realizar a criação de de uma chave que utilize "e-mail" ou "telefone" O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro: | Endpoint | Mensagem de erro | | ------------- | -------------------------------------------------------------------------------------- | | /api/v2/Chave | Código da conta não identificado na requisição. Verifique autenticação AuthCompany | | /api/v2/Chave | Erro - Generico Ocorreu um erro na requisição | | /api/v2/Chave | Erro SBP | | /api/v2/Chave | Conta inválida | | /api/v2/Chave | Agência inválida | | /api/v2/Chave | Necessário informar Conta + ContaDigito ou ContaPgto | | /api/v2/Chave | Conta inválida | | /api/v2/Chave | Conta != Ativa | | /api/v2/Chave | Operador não encontrado | | /api/v2/Chave | Parceiro não autorizado para esta conta | | /api/v2/Chave | É necessário informar um código de autenticação | | /api/v2/Chave | É necessário informar o código mfa da autenticação | | /api/v2/Chave | MFA não encontrado com este código de autenticação, solicite um novo | | /api/v2/Chave | Tipo chave pix inválido para o tipo informado na solicitação de MFA | | /api/v2/Chave | Tipo chave pix inválido para o tipo informado na solicitação de MFA | | /api/v2/Chave | Chave inválida para o MFA solicitado | | /api/v2/Chave | Este MFA não é compatível com a chave informada | | /api/v2/Chave | Token inválido ou já expirou | | /api/v2/Chave | Dados do correntista titular não encontrados | | /api/v2/Chave | Para continuar, o telefone informado deverá constar nos dados do correntista principal | | /api/v2/Chave | Para continuar, o e-mail informado deverá constar nos dados do correntista principal | | /api/v2/Chave | Não foi possível identificar o correntista titular da conta | | /api/v2/Chave | Correntista não permitido para esta conta | | /api/v2/Chave | Não é possível criar uma chave pix para uma conta vinculada | | /api/v2/Chave | Correntista não informado | | /api/v2/Chave | | | /api/v2/Chave | Não é permitido informar o campo 'chave' para criar chave do tipo | | /api/v2/Chave | Tipo de chave inválida. Correntista não é pessoa física | | /api/v2/Chave | Tipo de chave inválida. Correntista não é pessoa jurídica | | /api/v2/Chave | Chave não pode ser informada para tipo aleatória | | /api/v2/Chave | Chave inválida. Telefone incorreto | | /api/v2/Chave | E-mail não informado | | /api/v2/Chave | E-mail não pode conter caracteres maiúsculos | | /api/v2/Chave | E-mail inválido | ## OpenAPI ````yaml post /api/v2/Chave openapi: 3.0.1 info: title: Api Externa BMP SPI description: '

Build Number: #0.0

' version: v1 servers: - url: https://api.ext.pix.dbs.moneyp.com.br/ description: Localhost security: - Bearer: [] paths: /api/v2/Chave: post: tags: - Chave summary: Criar chave PIX por MFA description: "

Scopes:

\r\napi.pix api.chave.criar" parameters: - name: IdempotencyKey in: header required: true schema: type: string - name: IgnoraHandshake in: header description: (somente em homologação) required: true schema: type: boolean default: true requestBody: content: application/json: schema: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarRequestV2 text/json: schema: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarRequestV2 application/*+json: schema: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarRequestV2 responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarResponse '400': description: Erro de negócio content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string '500': description: Erro interno do servidor content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string components: schemas: BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarRequestV2: type: object properties: contaDto: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.Conta.ContaDto description: Objeto detalhado da conta bancária.* nullable: true tipoChave: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoChavePix' description: |- Tipo da chave.* Valores: 0 - CPF 1 - CNPJ 2 - TELEFONE 3 - EMAIL 4 - EVP chave: type: string description: Chave pix a ser criada.* nullable: true codigoAutenticacao: type: string description: >- Identificador único (UUID) para validar a autenticidade da solicitação.* format: uuid codigoMfa: type: string description: Código recebido para autenticaçâo multifator (MFA).* nullable: true additionalProperties: false BMPSPB.Domain.Messaging.API.Pix.Chave.Criar.CriarResponse: type: object properties: sucesso: type: boolean mensagem: type: string nullable: true additionalProperties: false BMPSPB.Domain.Messaging.API.Shared.Conta.ContaDto: type: object properties: agencia: type: string description: |- Número da agência bancária.* Observações: - O número da agência pode ter no máximo 4 caracteres. nullable: true agenciaDigito: type: string description: >- Dígito verificador da agência bancária. Observações: - O dígito verificador da agência bancária pode ter no máximo 1 caracter. nullable: true conta: type: string description: >- Número da conta bancária. Observações: - O número da conta bancária pode ter no máximo 12 caracteres. - Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (```contaPgto```) ou o 'número da conta' (```conta```) e o 'dígito verificador' (```contaDigito```). - Caso o 'número da conta com dígito' (```contaPgto```) seja informado, não é necessário preencher os campos 'número da conta' (```conta```) e 'dígito verificador' (```contaDigito```). - Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital. nullable: true contaDigito: type: string description: >- Dígito verificador do número da conta bancária. Observações: - O dígito verificador do número da conta bancária pode ter no máximo 1 caracter. nullable: true contaPgto: type: string description: >- Número da conta bancária seguido do dígito verificador. Observações: - O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres. nullable: true tipoConta: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta' description: |- Tipo da conta.* Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario nullable: true modeloConta: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta' description: |- Modelo da conta.* Valores: 1 - Movimento 2 - Escrow 3 - Vinculada nullable: true additionalProperties: false BMPSPB.Infra.Enums.TipoChavePix: enum: - 0 - 1 - 2 - 3 - 4 type: integer description: '' format: int32 BMPSPB.Infra.Enums.TipoConta: enum: - 1 - 2 - 3 - 4 type: integer description: '' format: int32 BMPSPB.Infra.Enums.ModeloConta: enum: - 1 - 2 - 3 type: integer description: '' format: int32 securitySchemes: Bearer: type: apiKey description: Copie 'Bearer ' + token name: Authorization in: header ````