Programadores

POST/v3/update_document/{uuid}

Atualizar um perfil de cadastro

Envie todos os dados editáveis do perfil e trate o formato legado de sucesso.

Nesta página
  1. Substituir os dados editáveis de um perfil
  2. Solicitação de atualização
  3. Opções avançadas: adicionar comprovantes enviados previamente
  4. Respostas legadas de sucesso e falha
  5. Limitações atuais da atualização e recuperação

Substituir os dados editáveis de um perfil

Atualize um perfil de cadastro existente pertencente à conta usando seu UUID local obtido de create_document ou documents. Esta operação altera os dados da conta e da operadora fornecedora. Ela não altera o tipo de identidade Personal/Business armazenado e não é uma operação PATCH de campos parciais.

Solicitação de atualização

Autentique-se com sua conta habilitada da API MultiTEL a partir de um endereço IP permitido. Os exemplos usam credenciais em variáveis de ambiente e dados fictícios. Leia os campos JSON status.code e status.msg, além da resposta HTTP.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

O exemplo apresenta um perfil Personal; substitua-o por todos os dados que deseja definir para o usuário final e pela assinatura autorizada dele. Não envie assinaturas de exemplo nem valores vazios como forma de preservar os dados. São aceitas entradas em JSON e codificadas como formulário.

Requisitos dos campos de atualização
CamposComportamento
first_name, last_name, city, postal_code, addressObrigatórios; cada um pode ter no máximo 64 caracteres.
phone_numberValor numérico obrigatório com pelo menos oito caracteres; use dígitos em formato internacional, incluindo o código do país.
signatureObrigatória. O portal fornece os bytes PNG codificados em Base64 sem o prefixo de URL de dados.
countryInforme um código ISO do país do endereço presente no catálogo de cadastro. Ele é resolvido pelo processador, embora a atualização de endereço revisada não altere o vínculo com o país.
nationalityCódigo ISO de país obrigatório para um perfil Personal existente.
company_name, incorporation_countryObrigatórios para um perfil Business existente; o nome da empresa pode ter no máximo 64 caracteres e o país de constituição deve ser um código ISO.
emailEndereço de e-mail válido opcional com até 254 caracteres. Omita-o para preservar o e-mail de contato armazenado; envie um valor vazio para apagá-lo localmente.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idEnvie os valores atuais que deseja definir. Os valores omitidos são considerados vazios por padrão e podem sobrescrever os valores já armazenados.

As regras de cadastro específicas de cada país podem exigir informações ou formatos adicionais. Não reconstrua uma atualização completa apenas a partir de get_document: sua resposta limitada omite os seletores de país, email e os identificadores de entidade. Mantenha seus dados de origem autorizados ou use o editor de documentos do portal.

Opções avançadas: adicionar comprovantes enviados previamente

Os arrays opcionais identity_encryptfiles e address_encryptfiles aceitam referências ativas pertencentes à conta provenientes de create_encrypt_files. Use a mesma categoria de entidade do arquivo enviado e envie a solicitação antes que a referência expire. Cada arquivo é anexado em uma solicitação de comprovante separada, mesmo que vários compartilhem o mesmo tipo de comprovante. Para um comprovante de identidade com vários arquivos, use o fluxo posterior de anexação de comprovantes com um único array.

Se uma prova de morada posterior for rejeitada para uma morada recém-criada, não substitua o UUID do perfil nem recrie a identidade repetidamente. Pare e verifique o perfil no portal ou junto do suporte. O caminho de leitura/consulta das provas de morada continua a ser uma limitação da revisão.

Respostas legadas de sucesso e falha

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

O código normal de sucesso deste endpoint é a string success, em vez do valor numérico 200. Uma falha normal no provedor ou no sistema local pode usar a string error. O código numérico 400 corresponde a campos inválidos ou falhas nos comprovantes, 404 a um perfil inexistente ou a uma referência inválida a um arquivo enviado, e 500 a um corpo vazio ou a um país não resolvido. Leia a mensagem e quaisquer entradas de validação; não considere HTTP 200, por si só, como sucesso.

Limitações atuais da atualização e recuperação

Um resultado que indique sucesso não garante que todos os campos no provedor tenham sido alterados. O código revisado pode salvar o perfil local após uma falha na atualização do endereço no provedor. A atualização de identidade no provedor não inclui email. Não está estabelecido que este caminho permita alterar o país do endereço ou sincronizar sua descrição. Se precisar dessas alterações, confira o resultado no portal e entre em contato com o suporte em vez de presumir que o cadastro no provedor foi atualizado.

A atualização não constitui uma única transação atômica: as alterações de identidade e a anexação de comprovantes podem ocorrer antes de uma falha posterior. Nenhuma chave de idempotência é disponibilizada. Após uma resposta incerta, confira o perfil e os anexos antes de tentar novamente; o envio repetido de comprovantes pode criar duplicatas. Atualizar um perfil não implica a aprovação dos comprovantes nem ativa um número.