> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pruva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# KYC scopes

> Individual identity checks: NIN, BVN, voter's card, passport, bank account, phone, and more.

KYC scopes verify an individual against a Nigerian register. Each takes a small set of inputs and returns the record on file when found.

<Note>
  The result fields shown for each scope are the common ones. Exactly which fields come back depends on the provider configured for your organization, and some are optional. Read the `result` object by key.
</Note>

## NIN by NIN number

`nin` looks up a National Identification Number.

<ParamField body="nin" type="string" required>
  The 11 digit NIN.
</ParamField>

```bash theme={null}
curl https://api.pruva.africa/v1/nin \
  -X POST \
  -H "X-Pruva-Key: pruva_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "nin": "12345678901" }'
```

Common result fields: `firstName`, `middleName`, `lastName`, `gender`, `dateOfBirth`, `phoneNumber`, `stateOfOrigin`, `lgaOfOrigin`, `residentialAddress`, and a portrait image field.

## NIN by phone number

`pnv` resolves a NIN from a registered phone number, returning the same kind of identity record.

<ParamField body="phone" type="string" required>
  The phone number registered against the NIN.
</ParamField>

```bash theme={null}
curl https://api.pruva.africa/v1/pnv \
  -X POST \
  -H "X-Pruva-Key: pruva_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "08012345678" }'
```

## Virtual NIN

`vnin` verifies a Virtual NIN, the tokenized form of a NIN.

<ParamField body="vnin" type="string" required>
  The Virtual NIN token.
</ParamField>

## BVN

`bvn` looks up a Bank Verification Number.

<ParamField body="bvn" type="string" required>
  The 11 digit BVN.
</ParamField>

```bash theme={null}
curl https://api.pruva.africa/v1/bvn \
  -X POST \
  -H "X-Pruva-Key: pruva_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "bvn": "12345678901" }'
```

Common result fields: `firstName`, `middleName`, `lastName`, `gender`, `dateOfBirth`, `phoneNumber1`, `phoneNumber2`, `email`, `stateOfOrigin`, `lgaOfOrigin`, `stateOfResidence`, `residentialAddress`, `nationality`, `maritalStatus`, `enrollmentBank`, `enrollmentBranch`, `registrationDate`, `levelOfAccount`, `watchListed`, and a portrait image field.

## Permanent Voter's Card

`pvc` verifies a Permanent Voter's Card by its VIN.

<ParamField body="vin" type="string" required>
  The Voter Identification Number.
</ParamField>

## Passport

`passport` verifies a Nigerian passport.

<ParamField body="passport_number" type="string" required>
  The passport number.
</ParamField>

## Bank account

`bank_account` verifies a bank account and returns the account name.

<ParamField body="bank" type="string" required>
  The bank, as a bank code or identifier.
</ParamField>

<ParamField body="account_number" type="string" required>
  The 10 digit account number.
</ParamField>

```bash theme={null}
curl https://api.pruva.africa/v1/bank_account \
  -X POST \
  -H "X-Pruva-Key: pruva_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "bank": "058", "account_number": "0123456789" }'
```

## Premium bank account

`premium_bank_account` is an enriched bank account check.

<ParamField body="account_number" type="string" required>
  The account number.
</ParamField>

<ParamField body="bank" type="string">
  The bank. Optional for this scope.
</ParamField>

## Phone number

`phone` verifies a phone number and returns the identity linked to it.

<ParamField body="phone" type="string" required>
  The phone number.
</ParamField>

```bash theme={null}
curl https://api.pruva.africa/v1/phone \
  -X POST \
  -H "X-Pruva-Key: pruva_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "08012345678" }'
```

<Note>
  A `found` or `not_found` result is charged; a `failed` result is not. NIN and BVN records include a portrait; where present, it is returned as a link to a securely stored image, not raw bytes in the response. See [Wallet and billing](/concepts/billing).
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.