LegalAcceptance

POST /v1/form/update

Below is an example illustrating the consumable format of FLegalAcceptanceComponent. 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-4UN0RDF0990D",
    "question": {
        "questionId": "afe785f0-9a1b-4cc8-8639-6644ceb02d8d",
        "question": "Do you accept these terms and conditions?",
        "kind": "LegalAcceptanceComponent",
        "settings": {
            "description": "<p>1. By accessing and using this website, you agree to abide by all applicable laws and regulations, and you acknowledge that any violation may result in legal action.</p><p>2. The content provided on this platform is for informational purposes only and should not be considered as professional advice. We are not liable for any damages or losses incurred from reliance on the information provided.</p><p>3. We reserve the right to modify, suspend, or terminate access to our services at any time without prior notice. Continued use of the website after such changes constitutes acceptance of the updated terms and conditions.</p>"
        }
    },
    "review": [
        ...,
        {
            "id": "b2556dcd-d0c0-430e-96fa-defc650356ac",
            "question": "Select the car brands you have",
            "answer": "Honda, BMW"
        }
    ],
    "message": null,
    "invoice": {
        "title": "Question Engine All cards No logic",
        "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
agree	bool

Example

Request Body

{
    "eServiceId": "663835dfae67d8704b6752b7",
    "refId": "SLH-4UN0RDF0990D",
    "questionId": "afe785f0-9a1b-4cc8-8639-6644ceb02d8d",
    "values": {
        "agree": true
    }
}

200

400