Request Verification | Nuapay Developer Hub

Request Verification RESTful API

API Details

The Request Verification endpoint allows you to:

Provide the name you want to verify.
The name you provide will be compared to the account holder name stored at the bank.
A successful request will result in a 201 verification created response. The verification is not completed at this point; initially, the verification request will have a PENDING status.
Note that the end user will complete the verification via the User Interface (as described in the End User Experience).
It is possible to have the verification flow as a pop-up (CHECKOUT mode) or the screen may be opened in a new browser Window/tab (REDIRECT); specify the required UI by setting the integrationType value.

Idempotency

Tip: We recommend that you use a unique idempotency key when working with this endpoint. The Idempotency-Key is a Header parameter in this API.

The Idempotency check is only against successful requests, so where a previous call has resulted in any of the following HTTP Response Codes, that Idempotency key may be reused without any issue:

401
403
404
408
500
501
503

Swagger Reference: Direct Debits & Credit Transfers

Note:

When working with our APIs, please use the Sandbox URI when testing and the Live URI when you move to Production.

LIVE     https://api.nuapay.com
SANDBOX  https://sandbox.nuapay.com/

If you haven't done so already and would like to do some testing, please Request Sandbox Access

Important: Endpoints and Webhooks may be extended from time to time and any changes we make will follow our Versioning and Backward Compatibility rules. This means that the code that you write today must be designed to be robust enough to handle any future changes (where a new object is added to (or removed from) a specific API response, for example).