Complete Journey API

An API endpoint using the POST method can be utilized to update the JourneyID's status as completed. It is designed to finalize a Journey ID to prevent further changes.

API Method

To update the JourneyID's status as completed

POST https://ekycportaldemo.innov8tif.com/api/ekyc/complete

Request Body

Name	Type	Description
journeyID*	string	Retrieve from 'Create JourneyID' API

200: OK Successfully update the JourneyID's status as completed completed

Response Code Block

{
    "status": "success",
    "messageCode": null,
    "message": null,
    "completeDateTime": 1680775433552
}

400: Bad Request Failed to update the JourneyID's status

{
    "status": "error"
}

500: Internal Server Error Server Error

{
    "status": "Internal Server Error"
}

Input Example

Request Code Block

{
    "journeyId":"584c7dfb-XXXX-XXXX-XXXX-b324ccaad308"
}

Important Information

For Complete Journey API to work correctly, all enabled eKYC steps (i.e. OkayID, OkayDoc etc.) for the user must be completed first. Otherwise it will return an INCOMPLETE_JOURNEY error.