Nofbox API Documentation

Base URL:

https://connect.nofbox.com/api

All endpoints:

• Use POST method
• Require Content-Type: application/json
• Require X-Api-Key header
• Require username in body parameter

Authentication

Every request must include your API key:

X-Api-Key: your_api_key

Example:

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

OAuth Login

Nofbox supports OAuth-based authentication, allowing users to sign in using their Nofbox account.

Step 1. Redirect the user

Redirect the user to the following URL:

https://portal.nofbox.com/oauth/rmi9pniq/?return_url={current_url}

Parameter Description

Property	Required	Description
return_url	Yes	The URL where the user should be redirected after completing the OAuth flow.

Step 2. User authentication

The user will be redirected to Nofbox where they can:

• Log in to an existing account, or
• Create a new account if they don't have one yet.

Step 3. User consent

After authentication, Nofbox displays a consent screen asking whether the user wants to grant your application access.

The user can choose:

• Continue — Grant access.
• Cancel — Deny access.

Step 4. Redirect back

If the user cancels

The user is redirected back to:

{return_url}

No additional query parameters are included.

If the user grants access

The user is redirected back to:

{return_url}?_nofbox_token={token}

Query Parameter Description

Property	Type	Description
_nofbox_token	String	A temporary OAuth token used to retrieve the authenticated user's information.

Exchange OAuth Token

Once your backend receives the _nofbox_token, exchange it for the user's information.

Endpoint

POST /api/oauth-verify/{token}

No request body is required.

Request

curl --request POST \
  --url https://connect.nofbox.com/api/oauth-verify/ldwjuhwhedkjkbkdke \
  --header 'content-type: application/json' \
  --header 'x-api-key: rmiqccbiqmse832ozwermiqccbiakjrtt13vzd'

Response

{
  "username": "johndoe",
  "email": "johndoe@gmail.com",
  "phone": "54dcb9a641309112d81709ffa1da605a-9982",
  "verified_at": "2026-08-20T10:13:10.034Z"
}

Send OTP

Send an OTP message.

Endpoint

POST /otp

Request

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

Body Parameters

Property	Type	Required	Description
username	string	Yes	Nofbox username
reference	string	Yes	OTP identifier reference
message	string	Yes	OTP information

Response

{
  "success": true
}

Verify OTP

Verify OTP code sent to the user.

Endpoint

POST /otp/verify

Request

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

Body Parameters

Property	Type	Required	Description
username	string	Yes	Nofbox username
reference	string	Yes	OTP reference
code	string	Yes	OTP code from user

Response

{
  "success": true
}

Send Notification

Send a regular notification message.

Endpoint

POST /notification

Request

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

Body Parameters

Property	Type	Required	Description
username	string	Yes	Nofbox username
message	string	Yes	Notification message
send_email	boolean	No	Send notification to user's email

Response

{
  "success": true
}

Error Response

Example error response:

{
  "message": "User not linked"
}

Possible errors:

Message	Description
Invalid API key	API key is invalid
User not linked	User has not linked Nofbox account
Invalid OTP code	OTP verification failed
OTP expired	OTP is no longer valid
Missing required field	Required parameter is missing

Flow Overview

Initial Setup

1. Provide link to Nofbox portal with return_url
2. User creates account and finish the verification
3. User will be redirected to the return URL
4. User inputs their nofbox username
5. Call /link-account with user provided username
6. Use the data in the response payload to update a user or create a new one
7. Your app can now send OTP and notifications

OTP Flow

1. Call /otp
2. User receives OTP in Nofbox
3. User enters code in your app
4. Call /otp/verify
5. Your app can now execute any action

Notification Flow

1. Call /notification
2. User receives message instantly in Nofbox

Logo Nofbox