> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria/bvn-verification/bvn-verify-otp.md). # Verificar OTP do BVN Verifique o **código OTP** recebido e retorna os **dados completos do BVN** incluindo as informações pessoais do titular. Este é o **passo final** do Fluxo de verificação BVN de 3 etapas para a Nigéria 🇳🇬. ### Endpoint ``` POST /kyc/nga/bvn/verify ``` ### Autenticação | Tipo | Localização | Nome | | ------- | ----------- | ------------- | | API Key | Cabeçalho | **x-api-key** | ### Corpo da solicitação **Content-Type:** `application/json` #### Parâmetros | Parâmetro | Tipo | Obrigatório | Descrição | | ----------- | ------ | ----------- | ------------------------------------------------ | | `sessionId` | string | **Sim** | **ID de sessão** obtido na etapa de iniciação. | | `otp` | string | **Sim** | Código OTP recebido pelo usuário. **6 dígitos.** | #### Exemplo de solicitação ```json { "sessionId": "5f9b1a2c-3d4e-4f5a-8b6c-7d8e9f0a1b2c", "otp": "123456" } ``` ### Respostas #### `200` Sucesso #### Parâmetros de resposta | Parâmetro | Tipo | Descrição | | ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------- | | `serviceResultCode` | integer | Código que indica o **resultado geral** da execução do serviço. Ver [Service Result Code](#service-result-code) | | `serviceTime` | string | Tempo de processamento **(milissegundos)**. | | `serviceResultLog` | string | Campo descritivo do resultado da execução do serviço. Inclui detalhes quando há um erro ou exceção no módulo. | | `serviceTransactionId` | string | Identificador de transação associado à solicitação processada pela API. | | `data` | object | Objeto com os dados completos do BVN. Veja a tabela a seguir. | #### Parâmetros de resposta — `data` O objeto `data` é retornado **sem mapeamento nem normalização**, preservando os nomes, o formato e a capitalização originais dos campos. | Parâmetro | Tipo | Descrição | | ------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------- | | `bvn` | string | Número de Verificação Bancária. | | `first_name` | string | Nome(s) do titular. | | `middle_name` | string | Segundo nome. | | `last_name` | string | Sobrenome(s) do titular. | | `dob` | string | Data de nascimento (`YYYY-MM-DD`). | | `phone_number` | string | Número de telefone registrado. | | `phone_number_2` | string | Número de telefone secundário. Pode ser `null`. | | `email` | string | Endereço de e-mail registrado. | | `gender` | string | Gênero. Valores possíveis: `Male`, `Female` | | `state_of_origin` | string | Estado de origem. | | `lga_of_origin` | string | LGA (Local Government Area) de origem. | | `lga_of_Residence` | string | LGA (Local Government Area) de residência. A `R` maiúscula é literal: o campo é retornado com essa capitalização exata. | | `address` | string | Endereço registrado. Pode ser `null` ou não estar presente de acordo com o registro BVN. | | `marital_status` | string | Estado civil. | | `nin` | string | Número Nacional de Identificação associado ao BVN. | | `nationality` | string | Nacionalidade. Pode ser `null` ou não estar presente de acordo com o registro BVN. | | `registration_date` | string | Data de registro do BVN. | | `watch_listed` | boolean | Indica se a pessoa se encontra em uma **lista de vigilância**. | | `photoId` | string | Fotografia do titular codificada em **Base64**. | #### Service Result Code O `serviceResultCode` indica o resultado geral da execução do serviço: | serviceResultCode | Descrição | Código HTTP | | ----------------- | -------------------------------------------------------------------------------------- | ----------- | | 200 | A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente. | 200 | #### Exemplo de resposta ```json { "serviceResultCode": 200, "serviceTime": "1500", "serviceResultLog": "Success", "serviceTransactionId": "996c790d-89d7-6c8g-c31c-7d1367ce77ef", "data": { "bvn": "12345678901", "first_name": "JOHN", "middle_name": "PAUL", "last_name": "DOE", "dob": "1990-01-15", "phone_number": "08012345678", "phone_number_2": null, "email": "john.doe@example.com", "gender": "Male", "state_of_origin": "Lagos State", "lga_of_origin": "Yaba", "lga_of_Residence": "Yaba", "address": "12 BEN STREET LAGOS", "marital_status": "single", "nin": "12345678901", "nationality": "Nigeria", "registration_date": "2015-06-20", "watch_listed": false, "photoId": "/9j/4AAQSkZJRgABAQAAAQABAAD..." } } ``` #### `400` Bad Request Erro retornado com o envelope do serviço (`serviceResultCode` reflete o código HTTP da resposta): ```json { "serviceResultCode": 400, "serviceResultLog": "Sorry, lookup failed. Please check the details and try again", "serviceTime": "151", "serviceTransactionId": "08ac9699-dc9e-4cdc-81d7-264f71838309" } ``` #### `502` Bad Gateway É retornado quando o serviço não está temporariamente disponível ou sua resposta não pôde ser interpretada. O corpo usa o envelope do serviço com `serviceResultCode: 500`: ```json { "serviceResultCode": 500, "serviceResultLog": "Service temporarily unavailable. Please try again later", "serviceTime": "3000", "serviceTransactionId": "38de2932-0f2h-7gff-14g0-597h04161632" } ``` #### `504` Gateway Timeout Erro de **timeout**, retornado com o envelope do serviço: ```json { "serviceResultCode": 504, "serviceResultLog": "Request timeout. Please try again", "serviceTime": "30000", "serviceTransactionId": "48ef3043-1g3i-8hgg-25h1-608i15272743" } ``` {% hint style="info" %} Os erros de autenticação (`401`/`403`) são rejeitados pelo **gateway antes de chegar ao serviço** e **não** usam o envelope `serviceResultCode`. Os erros de validação da plataforma usam o formato `application/problem+json`. Consulte [Tratamento de erros](/docs.facephi-pt-br/api-rest/identity-api/identity-api-reference/onboarding/kyc/nigeria.md#manejo-de-errores) para obter detalhes das três formas de resposta. {% endhint %}