Nofbox API

https://www.nofbox.com/p/docs
Admin
Nofbox API provides account linking, OTP, and notification delivery services for applications to...
Tokens:1,268
Snippets:28
Trust Score:2.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example API Key Header in Curl

Source: https://www.nofbox.com/p/docs

Example of how to include the API key in a curl request.

```bash
curl --header 'x-api-key: your_api_key'
```

--------------------------------

### Example Error Response

Source: https://www.nofbox.com/p/docs

Example of an error response from the Nofbox API.

```json
{
  "message": "User not linked"
}
```

--------------------------------

### Link Account Response (Already Linked)

Source: https://www.nofbox.com/p/docs

Example JSON response when an account is already linked.

```json
{
  "linked": true,
  "email": "7d055ac5b1588ba628851571ddcf39a3-he****@gmail.com",
  "phone": "54dcb9a641309112d81709ffa1da605a-9982",
  "username": "johndoe"
}
```

--------------------------------

### Link Account Response (Not Linked Yet)

Source: https://www.nofbox.com/p/docs

Example JSON response when an account is not yet linked.

```json
{
  "linked": false,
  "url": "https://portal.nofbox.com/linking/verif-token-here"
}
```

--------------------------------

### Unlink Account Response

Source: https://www.nofbox.com/p/docs

Example JSON response after unlinking an account.

```json
{
  "success": true
}
```

--------------------------------

### Base URL

Source: https://www.nofbox.com/p/docs

The base URL for all Nofbox API endpoints.

```text
https://connect.nofbox.com/api
```

--------------------------------

### Verify OTP Endpoint

Source: https://www.nofbox.com/p/docs

Curl request to the verify OTP endpoint.

```bash
curl --request POST \
  --url https://connect.nofbox.com/api/otp/verify \
  --header 'content-type: application/json' \
  --header 'x-api-key: r7ityaiqx5t0snzxblr7ityaiasesc5mqxho' \
  --data '{ \
  "user_id": "100", \
  "reference": "login", \
  "code": "030628" \
}'
```

--------------------------------

### Link Account Endpoint

Source: https://www.nofbox.com/p/docs

Curl request to the link account endpoint.

```bash
curl --request POST \
  --url https://connect.nofbox.com/api/link-account \
  --header 'content-type: application/json' \
  --header 'x-api-key: rmiqccbiqmse832ozwermiqccbiakjrtt13vzd' \
  --data '{ \
  "user_id": "100", \
  "return_url": "https://your-app.com/nofbox-return/100" \
}'
```

--------------------------------

### API Key Authentication Header

Source: https://www.nofbox.com/p/docs

Header required for authenticating API requests.

```text
X-Api-Key: your_api_key
```

--------------------------------

### Send OTP Endpoint

Source: https://www.nofbox.com/p/docs

Curl request to the send OTP endpoint.

```bash
curl --request POST \
  --url https://connect.nofbox.com/api/otp \
  --header 'content-type: application/json' \
  --header 'x-api-key: r7ityaiqx5t0snzxblr7ityaiasesc5mqxho' \
  --data '{ \
  "user_id": "100", \
  "reference": "login", \
  "message": "Use this OTP code to login to Your-App" \
}'
```

--------------------------------

### Send Notification Endpoint

Source: https://www.nofbox.com/p/docs

Curl request to the send notification endpoint.

```bash
curl --request POST \
  --url https://connect.nofbox.com/api/notification \
  --header 'content-type: application/json' \
  --header 'x-api-key: r7ityaiqx5t0snzxblr7ityaiasesc5mqxho' \
  --data '{ \
  "user_id": "100", \
  "message": "Deposit $1.0 received successfuly" \
}'
```

--------------------------------

### Unlink Account Endpoint

Source: https://www.nofbox.com/p/docs

Curl request to the unlink account endpoint.

```bash
curl --request POST \
  --url https://connect.nofbox.com/api/link-account/unlink \
  --header 'content-type: application/json' \
  --header 'x-api-key: r7iqf2xiqm1gfy0ntyjr7iqf2xiadhb9z9tdne' \
  --data '{ \
  "user_id": "100" \
}'
```
Tokens:
Raw