> For the complete documentation index, see [llms.txt](https://softcom-1.gitbook.io/kwiklli-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://softcom-1.gitbook.io/kwiklli-docs/api-resources/get-linking-otp.md).

# Enroll New User

This endpoint allows you to enroll new users.

## Request OTP

<mark style="color:green;">`POST`</mark> `https://api-npay.bluegreensoft.com/v1/banks/link-status`

This endpoint allows you to initiate the enrollment process by making a request for an OTP.

#### Headers

| Name   | Type   | Description                 |
| ------ | ------ | --------------------------- |
| appKey | string | This is the bank's API key. |

#### Request Body

| Name          | Type   | Description                                                                   |
| ------------- | ------ | ----------------------------------------------------------------------------- |
| phoneNumber   | string | <test@example.com>/23481012345678 \<email address or a Nigerian phone number> |
| bankCode      | string | The bank code of the sender's bank                                            |
| accountNumber | string | The NUBAN account number that is being linked                                 |

{% tabs %}
{% tab title="200 " %}

```
{
    "status": true,
    "message": "otp sent succesfully",
}
```

{% endtab %}
{% endtabs %}

## Provide OTP

<mark style="color:green;">`POST`</mark> `https://api-npay.bluegreensoft.com/v1/banks/activate/link-status`

This endpoint allows you to complete the enrollment process by entering a valid OTP.

#### Headers

| Name   | Type   | Description                 |
| ------ | ------ | --------------------------- |
| appKey | string | This is the bank's API key. |

#### Request Body

| Name        | Type   | Description                                                                    |
| ----------- | ------ | ------------------------------------------------------------------------------ |
| accountName | string | The user account name                                                          |
| bvn         | string | 09020000039 < valid Nigeria Bvn >                                              |
| bankCode    | string | The bank code of the sender's bank                                             |
| otp         | string | The OTP received at the phone number or email address                          |
| phoneNumber | string | <test@example.com>/23481012345678  < email address or a Nigerian phone number> |

{% tabs %}
{% tab title="200 " %}

```
{
 "status": true,
   "message": "account activated successfully",
   "data": {
       "last_login": "2020-09-30T09:00:59.602Z",
       "blocked": false,
       "firstLogin": true,
       "status": "active",
       "source": "WEB",
       "_id": "5f744bb03a4g1f0b3bc12ca4",
       "deleted": false,
       "username": "07053796646",
       "accountType": "PHONE",
       "role": "CUSTOMER",
       "createdAt": "2020-09-30T09:11:12.700Z",
       "updatedAt": "2020-09-30T09:11:12.700Z",
       "__v": 0
 }

```

{% endtab %}
{% endtabs %}
