Personalização de provedores de e-mail e SMS

Para autenticar seu domínio de e-mail, use as Email Domain Authentication APIs. Para obter mais informações sobre as APIs, consulte Autenticação de domínio de e-mail.

1. Registre seu domínio de e-mail. https://{tenanturl}/config/v1.0/email-domain-auth
   exemplo

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth \
        --header 'accept: application/json' \
        --header 'content-type: application/json'

2. Obtenha os registros DNS do seu domínio de e-mail. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
   exemplo

   curl --request GET \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

3. Verifique o status do seu domínio de e-mail. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
   exemplo

   curl --request POST \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
        --header 'accept: application/json'

4. Para alterar ou atualizar seu domínio de e-mail personalizado, você deve excluir o domínio de e-mail personalizado existente da notificação e, em seguida, registrar o novo.

   Exclua seu domínio de autenticação de e-mail. https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

   exemplo

   curl --request DELETE \
        --url https://tenant_url/config/v1.0/email-domain-auth/domain \
        --header 'accept: application/json'

• O provedor externo de SMS deve disponibilizar um endpoint de webhook POST em HTTP para receber solicitações de notificação de OTP de IBM Verify.
• O endpoint deve colocar imediatamente as solicitações na fila e retornar uma resposta do tipo " HTTP ".

{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}

destinationPhoneNumber

O número de telefone do destinatário no formato E.164.

content

O texto completo da mensagem SMS exibido ao usuário.

category

OTP

language

O código de localidade ou idioma, por exemplo, en-US.

otp

O valor da senha de uso único.

correlation

O ID para correlacionar a OTP com um fluxo de verificação; normalmente exibido na mensagem.

expiry

O tempo de validade em minutos.

202 Aceito

Solicitação adicionada à fila com sucesso.

400 Solicitação Inválida

Formato da carga útil inválido.

Erro Interno do Servidor 500

O provedor não conseguiu processar.

{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}

{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}