Carta de condução da África do Sul - API de verificação

​

Cobertura

• Cobertura: —
• País: África do Sul
• ID do serviço: zaf_drivers_license
• Domínio de dados: Identidade
• Categoria: DriverLicence

​

Entradas

• Entradas obrigatórias: national_id, last_name, initials, licence_number
• Entradas opcionais: first_name, date_of_birth, vendor_data
• Consentimento: Não é necessário
• Disponibilidade no fluxo: Disponível no fluxo com mapeamento de campos
• Cobertura: —
• Preço: $0.80 por consulta bem-sucedida

​

Parâmetros do corpo

​

Regras de entrada e notas de validação

• Envie os campos indicados acima exatamente como foram recolhidos do utilizador ou do documento.
• A Didit valida os campos obrigatórios antes de chamar a base de dados. Os pedidos rejeitados antes da consulta à fonte não são cobrados.

​

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_drivers_license" \
  -F "vendor_data=user-1234" \
  -F "national_id=SAMPLE-NID-12345" \
  -F "last_name=Doe" \
  -F "initials=JD" \
  -F "licence_number=LIC123456"

Todas as chamadas bem-sucedidas devolvem HTTP 200. O campo outcome_code indica o que aconteceu de facto, distinguindo, por exemplo, uma divergência biométrica real (BIOMETRIC_NO_MATCH) de uma selfie que não pôde ser lida (BIOMETRIC_IMAGE_UNUSABLE). O status apresentado é o estado predefinido da funcionalidade; as ações de Correspondência parcial / Sem correspondência que tiver configurado podem substituí-lo.

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_drivers_license",
      "service_name": "South Africa - Driving License Verification",
      "source_data": {
        "expiration_date": "2030-05-31",
        "first_name": "John",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "vehicle_codes": "EB"
      },
      "validation": {
        "full_name": "full_match",
        "identification_number": "full_match"
      }
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_drivers_license",
      "service_name": "South Africa - Driving License Verification",
      "source_data": {
        "licence_valid": false
      },
      "validation": {}
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "ZAF",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "zaf_drivers_license",
      "service_name": "South Africa - Driving License Verification",
      "source_data": {
        "licence_valid": true
      },
      "validation": {}
    }
  ]
}

​

Dados devolvidos

• expiration_date
• first_name
• identification_number
• last_name
• licence_valid
• vehicle_codes

​

Preços e SLAs

• Preço por chamada: $0.80 USD.
• Faturação: por consulta bem-sucedida. Não lhe é cobrado qualquer valor 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 significa cada resultado

• MATCH - o registo devolveu um registo de carta para este número, e os dados que submeteu correspondem a esse registo. source_data contém o registo: identification_number (o número da carta), first_name e last_name, vehicle_codes (as categorias da carta, por exemplo EB, C1) e expiration_date (a data de validade do cartão da carta).
• INCONCLUSIVE - o registo aceitou a consulta, mas não devolveu nenhum registo de carta, pelo que não havia nada com que comparar os dados submetidos. source_data.licence_valid é true, validation está vazio e match_type é null. Nada sobre a carta fica confirmado, pelo que a verificação é enviada para revisão. Isto acontece mesmo quando outro serviço do mesmo pedido, como a verificação do número de identificação nacional, correspondeu à pessoa, porque isso confirma a pessoa e não a carta.
• NO_MATCH - o registo procurou a carta e indicou que não é válida (source_data.licence_valid: false). Aplica-se a sua ação de não correspondência.
• REGISTRY_ERROR - o registo não executou a pesquisa, pelo que nada ficou estabelecido sobre a carta. A verificação é enviada para revisão e não é faturada.

​

Continuar a ler

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