Skip to main content
POST
/
v1
/
loans
/
{applicationId}
/
board-resolution
Upload Board Resolution
curl --request POST \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/board-resolution \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "file_url": "https://storage.example.com/documents/board-resolution.pdf"
}
'
{
  "status": "success",
  "message": "Board resolution submitted"
}

​
Overview

Links a board resolution document to the loan application. Required for all business customers except sole proprietors. Sole proprietors skip this step. Two-step process:
  1. Upload the file via POST /v1/loans/:applicationId/documents with file_tag = BOARD_RESOLUTION_DOC. Save the file_url returned.
  2. Pass that file_url to this endpoint.

​
Request

Method: POST
URL: /v1/loans/:applicationId/board-resolution

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
applicationIdPathstringYesApplication ID.

​
Request Body

{
  "board_resolution_url": "https://storage.carbon.ng/files/abc123def456"
}
FieldTypeRequiredDescription
board_resolution_urlstringYesValid https:// URL. Must be the file_url returned by POST /documents.

​
Response

​
200 OK

{
  "status": "success",
  "data": {}
}

​
Error Responses

StatusMessageCause
400board_resolution_url is requiredField missing
400board_resolution_url must be a valid URLNot a valid https:// URL
400Application not foundInvalid applicationId
422Application has no loan IDApplication not yet registered
400Offer must be accepted before uploading board resolutionAccept the offer first
400Document not foundURL does not match any previously uploaded file

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
applicationId
string
required

Body

application/json

Provide the required values for the request body.

​
file_url
string
required
Example:

"https://storage.example.com/documents/board-resolution.pdf"

Response

200 - application/json

Successful response

The response is of type object.