Page cover

Update Account Request Details

Endpoint

PATCH {{base_url}}/v1/accounts/requests/<request_id>

Description

This endpoint is used to edit details of an account request that has been submitted by the organisation. It cannot be used on already approved requests

URL Parameters

request_id (string): The request ID of the account you want to make edits to.

Request Body

The request body should be a form-data object containing the previously provided fields to be updated (as applicable):

  • firstName: "John"

  • companyName: "Prune"

  • idFile: passport.jpg , etc

Example Request

Key
Value
Type

firstName

John

string

idFile

passport.jpg

file

companyName

Prune

string

Notes:

  • File upload size limit is 500KB

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

  • Only a requestStatus that is "PENDING" can be updated

Response

On success, the API will return a JSON object containing the details of the requested account.

{
    "status": true,
    "message": "Account request updated successfully",
    "data": {
        "id": "c866e384-0df1-4609-8bd7-4a9a332gf981",
        "status": "PENDING",
        "accountType": "CORPORATE",
        "documentData": {
            "directors": {
                "director_1": {
                    "idType": "identityCard",
                    "poaType": "utilityBill",
                    "idFileURL": "https://xxxxxxx-xxxxx/ID.png",
                    "poaFileURL": "https://xxxxxxx-xxxxx/Util.png",
                    "idFileBackURL": "https://xxxxxxx-xxxxx/idBack.png"
                }
            },
            "shareholders": {
                "shareholder_1": {
                    "idType": "identityCard",
                    "poaType": "utilityBill",
                    "idFileURL": "https://xxxxxxx-xxxxx/ID.png",
                    "poaFileURL": "https://xxxxxxx-xxxxx/Util.png",
                    "idFileBackURL": "https://xxxxxxx-xxxxx/idBack.png"
                }
            }
        },
        "createdAt": "2025-07-17T12:12:20.554Z",
        "companyId": "113b018f-j323-458e-8342-e5ba94b95dca",
        "currencyId": "06ff7250-c5c5-4872-b31d-b3f7bar33aa49",
        "companyName": "PrunePayment LTD"
    },
    "code": 200
}

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.

Last updated