Document Verification Open Journey Service - IdCanopy API Documentation

POST

openJourney

Copy
curl --request POST \
  --url https://api-umbrella.io/api/services/openJourney \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "passThroughData": {}
}'

Copy
{
  "journeyId": "uniqueJourneyIdentifier",
  "passThroughData": {}
}

For a usage description of the Document Verification Open Journey Service, please refer to the Document Verification page.

Endpoint

POST /openJourney

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

passThroughData

object

Optional metadata to be carried through the journey.

Response

200

application/json

Successfully opened verification journey.

journeyId

string

Unique identifier for the verification journey.

Example:

"uniqueJourneyIdentifier"