Page cover

Update Account Request Details

Endpoint

PATCH {{}}/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"

  • idFile: passport.jpg

Example Request

Key
Value
Type

firstName

John

string

idFile

passport.jpg

file

Notes:

  • File upload size limit is 500KB

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

Response

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

{
        "id": "d19f128c-a8a9-47a6-9260-df99f940a1e2",
        "status": "PENDING",
        "firstName": "Emmanuel",
        "lastName": "Osuohia",
        "country": "NG",
        "accountType": "USER",
        "documentData": {
            "idType": "identityCard",
            "poaType": "utilityBill",
            "idFileURL": "https://xxxxxxx-xxxxx/Screenshot%202024-08-08%20at%2022.17.55.png",
            "poaFileURL": "https://xxxxxxx-xxxxx/Screenshot%202024-08-14%20at%2010.25.12.png",
            "idFileBackURL": "https://xxxxxxx-xxxxx/Screenshot%202024-08-05%20at%2012.42.34.png"
        },
        "createdAt": "2024-08-22T13:01:14.422Z",
        "companyId": "27dc0e6c-ef5b-41c5-ad55-2208fc543e1a"
}

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