Request User Account

Endpoint

POST {{}}/v1/accounts/request-account

Description

This endpoint is used to request the creation of a new user account, default currency is euro (more currencies on the way!!).

Request Body

The request body should be a form-data object containing the following fields:

• firstName: "John",

• lastName: "Doe",

• countryShort: "NG"

  (Acceptable country shorts are ; UK, FR, DE, IT, ES, NG, BJ, ML, TG, CI, US. See more)

• idType: "identityCard", (See list of acceptable ID Types by country)

• idFile: "idFile.jpeg",

• poaType: "utilityBill", (See list of acceptable POA Types)

• poaFile: "utility.jpeg"

• idFileBack: "idFileBack.jpeg", Non-passport ID types (identity card, driving license, and residence permit) require an "idFileBack" field for a successful request.

Important Notes

• ID and POA type identifiers are case-sensitive. Click here to learn more.

• File upload size limit is 500KB

• Acceptable file extensions are : ".jpeg", ".jpg", ".png", ".pdf"

Example Request

Field	Type	Value
firstName	string	John
lastName	string	Doe
countryShort	string	NG
idType	string	identityCard
idFile	file	idCard.jpg
idFileBack	file	idback.jpeg
poaType	string	utilityBill
poaFile	file	utilityBill.pdf

Response

The API will return a JSON object containing the details of the requested account. There are two possible outcomes: either a successful response, or a pending status.

Successful Response

{
    "status": true,
    "message": "Account Created",
    "data": {
        "id": "9281dbc0-dd76-4193-8c16-1292ee8ba841",
        "firstName": "Ebube",
        "lastName": "Anyiam",
        "accountId": 35,
        "accountName": "Ebube Anyiam",
        "accountNumber": "GB1204550505050533",
        "accountBalance": 0,
        "accountDocuments": {
            "idType": "identityCard",
            "poaType": "utilityBill",
            "idFileURL": "https://xxxxxxxxxxxxxxxxxxxx/national-id.jpeg",
            "idFileBackURL": "https://xxxxxxxxxxxxxxxxxxxx/natIDback.png"
            "poaFileURL": "https://xxxxxxxxxxxxxxxxxxxx/aecd-bill.jpeg"
        },
        "createdAt": "2024-04-07T22:14:41.889Z",
    },
    "code": 201
}

Pending Response

{
    "status": true,
    "message": "An account request has been created for kyc verification",
    "code": 202
}

Error Responses

Include common error responses and their meanings.

• 400 Bad Request: One or more fields are missing or invalid.

• 500 Internal Server Error: An error occurred on the server.