Stop

POST /v1/form/update

Below is an example illustrating the consumable format of StopComponent. 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'.

Users will not be able to move forward to another question if they reach the StopComponent. They must read the instructions and resolve the issue by taking a different path

{
    "status": "NEXT",
    "refId": "SLH-4UN8FXYDC59R",
    "question": {
        "questionId": "ce54f5c6-abba-4ae3-8445-22bac2f7c1e0",
        "question": "You do not qualify for this program",
        "kind": "StopComponent",
        "settings": {}
    },
    "review": [
        {
            "id": "f1d702b8-c457-4e5e-8127-b291cd48721f",
            "question": " Upload a copy of your Id",
            "answer": "download.jpg"
        }
    ],
    "message": null,
    "invoice": {
        "title": "Demo Cards API 3",
        "quantity": 1,
        "currency": "XOF",
        "totalCost": 1000.0
    }
}

Last updated