Attachment

POST /v1/form/update

Prior to using this API, you will need to upload your file using the UploadFile API

Below is an example illustrating the consumable format of Attachment. The 'NEXT' status indicates that you haven't reached the end of the form yet. Each question is uniquely identified by an ID stored in 'questionId'.

Object

{
    "status": "NEXT",
    "refId": "SLH-4UN8FXYDC59R",
    "question": {
        "questionId": "f1d702b8-c457-4e5e-8127-b291cd48721f",
        "question": " Upload a copy of your Id",
        "kind": "AttachmentComponent",
        "settings": {}
    },
    "review": [],
    "message": null,
    "invoice": {
        "title": "Demo Cards API 3",
        "quantity": 1,
        "currency": "XOF",
        "totalCost": 1000.0
    }
}

Response to the question

Headers

Name	Value
Content-Type	application/json
CLIENT_ID	<client id>

Body

In addition to the API keys specified in the Headers, ensure to include the eServiceId, refId, questionId. Upon a successful request, you will receive the next question. You'll recognize reaching the end of the form when the status is 'COMPLETED'.

values class field(s)	Format
files	Array

Example

Request Body

{
    "eServiceId": "665f55b2c5020ff96caf0ee7",
    "refId": "SLH-4UN8FXYDC59R",
    "questionId": "f1d702b8-c457-4e5e-8127-b291cd48721f",
    "values": {
        "files": [
            {
                "fileName": "download",
                "extension": ".jpg",
                "mimeType": "image/jpeg",
                "id": "6a3b3df5-c052-4488-92fc-0d033beae22f",
                "filePondId": "202406042010596949"
            }
        ]
    }
}

200

400