Validação de titular de conta bancária na África do Sul - API de verificação

​

Cobertura

• Cobertura: —
• País: África do Sul
• ID do serviço: zaf_bank_account_holder
• Domínio de dados: Financeiro
• Categoria: Banca

​

Entradas

• Campos obrigatórios: national_id, bank_account_number, bank_name
• Campos opcionais: account_type, first_name, last_name, initials, email, phone_number, vendor_data
• Consentimento: Obrigatório
• Disponibilidade no fluxo: Disponível no fluxo com mapeamento de campos
• Cobertura: —
• Preço: $0.40 por consulta bem-sucedida

​

Parâmetros do corpo

​

Regras de entrada e notas de validação

• account_type tem de ser um dos tipos de conta AVS sul-africanos: current, savings, transmission, subscriptionShare, notKnown. A correspondência não distingue maiúsculas de minúsculas. Omita o campo quando não souber o tipo de conta: a Didit envia então notKnown, e a verificação cruzada do tipo de conta é reportada como não confirmada, em vez de falhar o pedido.

​

Como chamar

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=ZAF" \
  -F "services=zaf_bank_account_holder" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "national_id=8708150847085" \
  -F "bank_account_number=1234567890" \
  -F "bank_name=ABSA" \
  -F "account_type=current" \
  -F "last_name=Doe" \
  -F "initials=JD"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_bank_account_holder",
      "service_name": "South Africa - Bank Account Holder Verification",
      "source_data": {
        "accepts_credits": true,
        "accepts_debits": true,
        "account_found": true,
        "account_number_length_valid": true,
        "account_open": true,
        "account_type_match": true,
        "id_match": true,
        "identification_number": "SAMPLE-ID-12345",
        "initials_match": true,
        "surname_match": true
      },
      "validation": {
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "ZAF",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "zaf_bank_account_holder",
      "service_name": "South Africa - Bank Account Holder Verification",
      "source_data": {
        "accepts_credits": true,
        "accepts_debits": true,
        "account_found": true,
        "account_number_length_valid": false,
        "account_open": true,
        "account_type_match": true,
        "id_match": true,
        "identification_number": "SAMPLE-ID-12345",
        "initials_match": true,
        "surname_match": false
      },
      "validation": {
        "full_name": "partial_match",
        "identification_number": "full_match"
      }
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_bank_account_holder",
      "service_name": "South Africa - Bank Account Holder Verification",
      "source_data": {
        "accepts_credits": false,
        "accepts_debits": false,
        "account_found": false,
        "account_number_length_valid": false,
        "account_open": false,
        "account_type_match": false,
        "id_match": false,
        "identification_number": "NO_MATCH",
        "initials_match": false,
        "surname_match": false
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}

​

Dados devolvidos

• accepts_credits
• accepts_debits
• account_found
• account_number_length_valid
• account_open
• account_type_match
• id_match
• identification_number
• initials_match
• surname_match

​

Preços e SLAs

• Preço por chamada: $0.40 USD.
• Faturação: por consulta bem-sucedida. Não é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
• Latência: p95 típico < 2 s.
• Disponibilidade: 99.9% por trimestre do lado da Didit; a disponibilidade das fontes a jusante varia consoante o país e o conjunto de dados.

​

O que confirma um MATCH

• account_found - o banco tem uma conta com este número. Tudo o resto não tem significado quando este valor é false.
• account_open - a conta está aberta. Uma conta pode ser encontrada e estar encerrada.
• id_match - a conta pertence ao número de identificação nacional que submeteu. Esta é a verificação para a qual o serviço existe.
• initials_match, surname_match - os initials e o last_name submetidos correspondem ao titular da conta registado.
• account_type_match - o account_type submetido corresponde ao tipo real da conta.
• email_match, phone_match - o email e o phone_number submetidos correspondem aos dados de contacto que o banco tem registados.
• accepts_debits, accepts_credits - a conta pode receber ordens de débito e créditos.
• account_number_length_valid - o número da conta tem o comprimento que o banco espera.

• MATCH - a conta existe e todos os campos que submeteu correspondem, incluindo id_match.
• PARTIAL_MATCH - a conta está associada ao titular identificado pelo número de identificação nacional submetido, mas pelo menos outro campo enviado não corresponde (por exemplo, um apelido escrito de forma diferente nos registos do banco). O outcome_detail indica os campos que falharam.
• NO_MATCH - o banco não tem nenhuma conta com esse número, ou a conta existe mas pertence a outra pessoa. Ambos são respostas conclusivas sobre a pessoa.

​

Valores aceites de bank_name e account_type

​

Distinguir uma conta inexistente de uma fonte indisponível

• A conta não existe - 200 OK, match_type: "no_match", outcome_code: "NO_MATCH", source_data.account_found: false. Uma resposta real do banco. A consulta é faturada, e aplica-se a sua ação para casos sem correspondência.
• A fonte não respondeu - 502 Bad Gateway com validation_errors[].code = empty_provider_response e retryable: true. Nada ficou estabelecido sobre a pessoa, nada é faturado, e o pedido pode ser repetido em segurança.
• A fonte recusou executar a consulta - 400 Bad Request com validation_errors[].code = provider_rejected_input e retryable: false. A fonte não pesquisou, porque não aceitaria o que lhe foi enviado. Corrija os dados; repetir os mesmos valores não pode resultar. Nada é faturado.
• A fonte respondeu e rejeitou os dados enviados - 502 Bad Gateway com validation_errors[].code = provider_invalid_input (por exemplo, um número de conta que não passa a verificação de formato do banco). Repetir o pedido não serve de nada até os dados serem corrigidos; nada é faturado.
• O pedido nunca saiu da Didit - 400 Bad Request, a indicar o campo a corrigir. Nada é faturado.

​

Continuar a ler

• Visão geral da Validação de base de dados da África do Sul
• Visão geral da Validação de base de dados
• Códigos de resultado