Criar reivindicacao
Inicia uma reivindicacao de portabilidade ou propriedade para assumir o controle de uma chave PIX atualmente registrada em outra conta. O status da reivindicacao sera inicialmente “OPEN” e devera passar por um processo de confirmacao. O status da chave para o reivindicador sera tipicamente 4 (IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST).
Autorizações
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).
Corpo
Resposta
Reivindicacao criada com sucesso
Valor da chave PIX.
"+5511987654321"
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")
0, 1, 2, 3, 4 3
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)
-1, 0, 1, 2, 3, 4, 5, 6, 7 1
Identificador unico da reivindicacao.
"claim_abc123xyz"
Descricao legivel do status da reivindicacao.
"OPEN"

