Update

Update an existing eService application

POST /v1/form/update

To initiate the form filling process, you must supply the eServiceId and refId. The anticipated response will include a question object encompassing all pertinent details, facilitating updates. Refer to the example below for clarity

Headers

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

Request Body

Name	Type	Description
eServiceId	string	ID of the eService
refId	string	Reference ID of application

Response Example

200

{
    "status": "NEXT",
    "refId": "SLH-4UMY45LATOFP",
    "question": {
        "questionId": "d6012cc3-c3d3-4ad8-80c3-76aefdc56af9",
        "question": "What is your level of education?",
        "kind": "SingleChoiceComponent",
        "settings": {
            "source": [
                "Bachelors",
                "Masters",
                "PhD"
            ]
        }
    },
    "review": [],
    "message": null,
    "invoice": {
        "title": "Rahisi Car Insurance",
        "quantity": 1,
        "currency": "XOF",
        "totalCost": 1000.0
    }
}

422

400

Response Body Definition

status	Inform the user if there is an error, more questions or you. Possible values are: NEXT: You have not reached the final question yet. COMPLETED: You have completed the question process and can proceed to the payment process." ERROR: question update validation errors
refId	Reference ID of application
question	Details of the question requiring update. Class definition will vary depending on the type, such as Boolean, FullName, etc. Refer to the documentation for further information.
question.questionId	Id of the question
question.question	Title of the question
question.kind	Type of the question eg Boolean, FullName, etc. Refer to the documentation for further information.
question.settings	Additional settings for the question. This can contain data source info
review	List of all the updated questions
message	Informational message for status NEXT, COMPLETED and ERROR
invoice	Current cost details of the form, based on selection choices