Actions – GBG IDscan Documentation

Actions

The API service exposes the following actions in JSON format:

Authentication

This action is used for user authentication. It accepts the login credentials and returns the user full name, his role and an authentication token.

For demonstration purposes, the system will be supported with service accounts to be used with authentication calls, no password policies are applied on these accounts, and these accounts are:

UsernamePasswordFormat
scanuserscanpasswordCase Sensitive
invuserinvpasswordCase Sensitive

Signature

[POST] https://{serviceURL}/idscanenterprisesvc/token 

Request/Response format: application/x-www-form-urlencoded

Parameters:

NameDescriptionFormat
UserNameMandatory, the user login nameThe key and value should be lower case sensitive string.
PasswordMandatory, the user passwordThe key should be lower case string; value
is case sensitive.
areaMandatory, application area (used to check if the user is authorised to access the required resource), possible values (investigation, scanning)The key and value should be lower case
sensitive string, see Areas Table.
grant_typeMandatory, the grant_type parameter must be set to “password”The key and value should be lower case
sensitive string,

Result:

Key NameDescriptionFormat
UsernameUser login nameString
FullNameUser full nameString
RoleUser roleString
TokenAuthentication tokenString, the key is in lower case

Important Notes: Notice that the content-type and payload type is “x-www-form-urlencoded” so the payload body will be in the form (grant_type=password&username=”yourusername”&password=”yourpassword”). If all is correct, you’ll notice that you’ve received signed token on the response.

The Authentication Token should be sent along with every forthcoming request in the http headers. The authentication token can be set in the HTTP request one of the following ways:

  • By using Cookie:
    • Cookie: token= DE14ydbxNEiUuIaV2tHN2A
  • By using Authorization Http header:
    • Authorization: DE14ydbxNEiUuIaV2tHN2A

Authentication action must be called before attempting Upload or Retrieval, each action has its designated value of the “area” parameter in the authentication request.

Calls must have an authentication token that was acquired with the appropriate “area” in order to do successful calls, the area names required for calls are as of the following:

Action NameAreaFormat
RetrievalInvestigationLower case string
UploadScanningLower case string

Response:

{
"access_token": "OpZPv7wD2pS1PVCqXQEvcA7UCdmeMk…", "token_type": "bearer",
"expires_in": 35999, "BranchCode": "",
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name": "Superadministrator", "FullName": "",
"AbbeyServiceCentre": "", "JourneyId": "",
"http://schemas.microsoft.com/ws/2008/06/identity/claims/role": "SuperAdministrator", ".issued": "Mon, 07 Jan 2019 07:00:18 GMT",
".expires": "Mon, 07 Jan 2019 17:00:18 GMT"
}

Upload

This action is used for uploading a document image to IDscan backend to be processed along with an optional face match input data to match two faces, the high level result of processing is included in the response of this action call.

Important note: Authentication must be done before calling this action, for more information please refer to Authentication section.

Signature

[POST] https://{serviceURL}/idscanenterprisesvc/journey/upload
Request/Response format: JSON

Body Parameters:

Parameter NameDescriptionFormat
AdditionalDataOptional, a dictionary of string values to be associated with
the case, all of the items included here will be returned in the
response payload.
Examples:
Username: Optional, User name conducting the upload, optional, used as metadata to identify the user sending the request.
BranchCode: Optional, used to identify the branch the request is coming from.
Name and Value Dictionary
ExcludeOutputImages
FromResponse
Optional, use “true” to exclude the output images from the
response to reduce its size, defaults to “false” means output
images will be included in the response payload
Boolean as string “true” or
“false”
IdentitiyMeansIdOptional, use when its intended to add more pages to a
previously added documents.
GUID
InputImagesMandatory, a list of images to process, see “Input Image
Object”, This list should at least contain an element named
“WhiteImage” which is the visible image of the document.
Object
IsDocumentExtractedMandatory, use “true” if the document was taken via scanner
or IDScan Mobile SDK otherwise if using web camera then
use “false”
Boolean
PersonEntryIdOptional, use when its intended to resume an entry by
adding more documents.
GUID
SourceMandatory, Indicates the device source of the image.
Possible values are:
1: Passport Scanner
2: Camera
3: A4 scanner
Integer

Input Image Object

KeyDescriptionFormat
NamePossible values: “WhiteImage” “NearInfraredImage”
“SelfiePhoto” “UltravioletImage”
String
ImageFormatThe format of the image, possible values: “jpg” and “bmp”.String
DataImage binary data.Base64 String encoded

Result:

Key nameDescriptionFormat
CurrentResultThe processing result. See Table for possible values.String
Doument sourceSee “Doument source” in Processed Document Object.String
EntryDataExtracted information from processed input.Name and Value Dictionary
EntryDateTimeDate and time of entry.DateTime
EntryImagesA list of the images to process, see “Entry Image Object”.List of Objects
HasErrorIndicates whether an error has happened during entry processing, in case of receiving three consequence errors, IDscan support team contact is advised.Boolean as string “true” or “false”
IsFinishedA flag to determine whether entry processing has been
completed and there are no required actions from the user.
Boolean as string “true”
or “false”
PersonEntryIdEntry unique GUID id of the entry.GUID
RequiredActionText string code to inform calling application with the required
action to continue entry processing if needed, possible values
differ based on entry workflow customisations.
String
ResultDetailsList of check result strings based on system configuration.List of string items
HighLevelResultThe processing result.String

Possible Processing result values for CurrentResult:

ResultsDescription
CaseUpdateFailedMight appear when using IDscan Case Management Module.
ErrorSavingDataIDscan Backend Services has encountered an error while saving the scan data to database, further information can be obtained from IDscan log files.
FailedThe scanned document image has failed due to one of the following:
1. A document in the entry was not recognized by IDES
2. A document in the entry did not pass validation checks
3. A document in the entry was expired
4. A document in the entry was rejected by document proof policy
5. A document in the entry was rejected by a business rule
PassThe entry has passed business rules & authentication checks and was saved successfully.
ProcessingErrorIDscan Backend Services has encountered an error while communicating with IDES, further information can be obtained from IDscan log files.
SpecifiedEntryNotFoundReturned as an error when specifying a value in the upload request parameter PersonEntryId that does not exist in the system.

Entry Image Object:

KeyDescriptionFormat
CreateDatetimeDate and time of image processing.DateTime
DataImage binary data.Base64 String encoded
Document roleDetermines for which side of the document image was captured, Possible values: (“ID Document”, “ID Document Back” applicable only with ID documents) and “A4 Paper” when scanning A4 documents.String
IdUnique ID of the imageGUID
IdentityMeansIdThe unique ID of the document record generated by processing the image.GUID
RoleA code name for the image. Possible values:
“ChipPhoto”, “FacePortraitImage”, “NearInfraredImage”
“SelfiePhoto”, “UltravioletImage”, “WhiteImage”
String

Example JSON

Request:

{
 "InputImages": [
 {
 "Data": "{{base64String}}",
 "ImageFormat": null,
 "Name": "WhiteImage"
 },
 ],
 "AdditionalData":[
 {"Name":"UserName","Value":"username"}, //OPTIONAL
 {"Name":"BranchCode","Value":"Web Upload"}, //OPTIONAL
 ],
 "IdentityMeansId":"00000000-0000-0000-0000-000000000000", //OPTIONAL
 "Source": "2",
 "IsDocumentExtracted": "true",
 "ExcludeOutputImagesFromResponse": "true" //OPTIONAL
 }

Response:

{
 "PersonEntryId": "f1d6ea32-cec2-46ad-a041-4bd53e17d450",
 "EntryDateTime": "2019-01-07T09:59:58.782926Z",
 "RequiredAction": "NONE",
 "CurrentResult": "Pass",
 "HighLevelResult": "Passed",
 "EntryImages": [{“Id”: "716d215a-ce33-4540-a776-021627e54d3d",
 "Role": "WhiteImage",
 "Data": “BASE64 string”,
 "CreateDatetime": "2015-10-23T07:53:04.5088722Z" }], //Entry Images depends on
 "ExcludeOutputImagesFromResponse” value, if true this will be empty.
 "IsFinished": true,
 "RequestId": "00000000-0000-0000-0000-000000000000",
 "HasError": false,
 "ResultDetails": [
 "UNDERAGERULE:SKIPPED",
 "DOCUMENTBACKSIDECHECK:SKIPPED",
 "DOCUMENTBLOCKINGPOLICY:PASSED",
 "DOCUMENTEXPIRY:SKIPPED",
 "DOCUMENTSUPPORT:PASSED",
 "DOCUMENTPROOFPOLICY:SKIPPED",
 "DOCUMENTVALIDATION:PASSED",
 "DOCUMENTACCEPTANCEPOLICY:PASSED"
 ],
 "EntryData": {
 "UserName": "username",
 "BranchCode": "Web Upload",
 "RequiredJourneySteps": "FRONTSIDE",
 "DocumentType": "National Identification Card",
 "CountryCode": "DEU",
 "ExtractedFields.DocumentNumber": "{{Extracted Document Number}}",
 "ExtractedFields.FirstName": "{{Extracted First Name}}",
 "ExtractedFields.BirthDate": "{{Extracted Birth Date}}",
 "ExtractedFields.BirthPlace": "{{Extracted Birth Place}}}}",
 "ExtractedFields.ExpiryDate": "{{Extracted Expiry Date}}",
 "ExtractedFields.LastName": "{{Extracted Last Name}}",
 "ExtractedFields.SecondLastName": "{{Extracted Second Last Name}}",
 "ExtractedFields.CardNumber": "",
 "ExtractedFields.NationalityCode": "DEU",
 "ExtractedFields.NationalityName": "German",
 "ExtractedFields.Signature": null,
 "ExtractedFields.FullName": "{{FULL NAME}}",
 "ScanReason": "",
 "AuthenticationLevel": "Default",
 "ScanReference": "1000020072"
 }
 }

End of upload response example.

Retrieval

This action is used to retrieve the journey definitions. It accepts a channel type and returns the Journey definitions for the channel type.

Signature:

[GET] http://serverUrl/idscanenterprisesvc/JourneyDefinition/GetAll
Request/Response format: JSON

URL Parameters:

Parameter DescriptionFormat
ChannelTypeNot mandatory, possible values are CaptureStudio, Web and MobileString

Results:

This is an array object

KeyDescriptionFormat
JourneyDefinitionA unique formatted id of the journey definition.GUID
NameName of the channel typeString
ChannelTypeIndex of the select channel type: CaptueStudio = 1, FileUpload = 2, WebCamera = 3, Camera = 4Integer
ChannelMediaPossible values: Scanner = 1, FileUpload = 2, WebCamera = 3, Camera = 4Integer
LastUpdatedDateTimeDate and time of the journey definition in local format of the server PCDateTime
IsActiveState of t he journey definitionBoolean
EntryDefinitionsEntry definition of the journey definitionObject

EntryDefinitions Array Objects:

KeyDescriptionFormat
JourneyEntryDefinitionA unique formatted id of the journey entry definitionGUID
JourneyDefinitionIdA unique formatted id of the journey definitionGUID
TypePossible values:
FRONTSIDE = 1,
BACKSIDE = 2,    
SELFIE = 3,
ADDRESSDOCUMENT=4, 
CHIPPHOTOFACEMATCH=5, 
LIVENESS = 6
Integer
OrderOrder of steps. Always frontsideis first, therefore this object is not functional currently.
Possible value: 0
Integer
IsOptionalSome steps can be optional based on the preference, however this object is not currently functional currently.
Possible value: False
Boolean

Important Note:

The authentication must be done before calling this action, for more information please refer to Authentication section.

Example URL

Request: http://serviceurl/IDScanEnterpriseSvc/JourneyDefinition/GetAll?channeltype=web

Response:

Note: The structure of the response will be the same regardless of the channel type but the entry definitions list in this example is for demonstration purposes only; possible list of entry definitions depends on the channel type and configuration type.

 [
   {
     "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
     "Name": "WJCS",
     "ChannelType": 2,
     "CapturingMedia": 2,
     "LastUpdatedDateTime": "2019-08-05T06:59:28.2378768",
     "IsActive": true,
     "EntryDefinitions": [
       {
         "JourneyEntryDefinitionId": "68a1ba6d-8f9e-4965-bfac-6b87f25cebc7",
         "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
         "Type": 1,
         "Order": 0,
         "IsOptional": false
       },
       {
         "JourneyEntryDefinitionId": "ef7c8a4d-8a43-4436-ae1e-bc6a6b8c833e",
         "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
         "Type": 3,
         "Order": 0,
         "IsOptional": false
       },
       {
         "JourneyEntryDefinitionId": "e87c9a1a-3bfd-4440-99f7-e179f14a993d",
         "JourneyDefinitionId": "ef644ffa-e2eb-49d3-b610-c827842b8eb5",
         "Type": 6,
         "Order": 0,
         "IsOptional": false
       }
     ]
   },
   {
     "JourneyDefinitionId": "9ddc0e50-b8cc-436c-b6c0-275e46412cd8",
     "Name": "wjcsscanner",
     "ChannelType": 2,
     "CapturingMedia": 1,
     "LastUpdatedDateTime": "2019-10-04T12:09:54.2237734",
     "IsActive": true,
     "EntryDefinitions": [
       {
         "JourneyEntryDefinitionId": "8ecef82b-432f-4a5a-9046-2c17c246e981",
         "JourneyDefinitionId": "9ddc0e50-b8cc-436c-b6c0-275e46412cd8",
         "Type": 1,
         "Order": 0,
         "IsOptional": false
       }
     ]
   }
 ] 

Retrieval

This action is used to retrieve the processing results for a processed journey. It accepts a journey ID and returns the processing results for the journey and a list of the processed documents in addition to the extracted fields for each processed document in the journey.

Important note: Authentication must be done before calling this action, for more information please refer to Authentication section.

Signature

[GET] https://{serviceURL}/idscanenterprisesvc/journey/get
Request/Response format: JSON

Url Parameters:

ParameterDescriptionFormat
JourneyIDMandatory, Reference number of the requested entry.String

Result:

KeyDescriptionFormat
InitiatedDateTime
Date and time of entry in local format of the server PC
DateTime
JourneyId A unique formatted id of the entryGUID
HighLevelResultDetails The details of the high level result decision. This will include the reasons that caused the journey to refer Values will vary depending on the configured business rules to refer a journey
HighLevelResult The processing result, see Table for possible values String
ProcessedDocuments Collection of processed documents (see Processed Document object) Object
ReferenceNumber Unique entry reference number String
AuthenticationToleranceLevel
Applied Authentication Tolerance Level in journey String
AdditionalData Set of Additional Data that linked to the journey Object

Possible Processing result for HighLevelResult:

Result
Description
Expired One or more of the documents in the case was expired
NotAccepted One or more of the documents in the case was not accepted by business rules
Notsupported One or more of the documents in the case was not recognized by IDES
Passed All documents in the case(entry) has passed the business rules and authentication checks
Refer One or more of the documents in the case did not pass authentication checks
Undefined The system does not have enough information to provide a decision on the case, possible reasons:
– System needs more documents or needs to scan the backside of the document as defined in business rules configurations.
– System needs to scan the document again due to bad image quality.

Processed Document Object:

KeyDescription
Format
IssuingCountryCode
The issuing country codeString, 3 digits ISO 3166-1 standard
IssuingCountryName The issuing country nameString
DocumentCategory High level grouping of doc types as of Document Expert knowledge
String
DocumentImages A list of output image objects in the following format: “Role”: “WhiteImage”, “Url”: “Http URL to download the image in jpg format”List of Object
DocumentName Friendly name of the document including the issuing country name String
DocumentSide
The captured side of the document. String. Possible Values: “Front”, “Back”
DocumentType Determines the document type, e.g. Passport, Driving License, Resident Permit etc. (see Annex1 for possible values)String
ExtractedFields List of the extracted fields from doc, see “Extracted Field Object” List of Object
HighLevelResult The processing result for a particular document image, see Table for possible valuesString
IsValidated
Determines whether the doc was validated by the system or not.
Provides an access to the high level overall result of the library authentication on the document.
true: The document has passed the authentication checks with an overall successful result.
false: The document failed many of the authentication checks that pose a concern on document state.
undetermined: The state of the checks was inconclusive this might be because not enough; Authentication checks were carried on the document or the checks returned an intermediate result.
String “true”, “false” or “undetermined”
ScanDateTime Date and time of scanning the document imageDateTime
DigitalTamperingValidatorDetermines the document is tampered or not String “Passed” or “Failed

Extracted Field Object

KeyDescriptionFormat
NameName of the extracted fieldString
ValueThe extracted value from the documentString
OCRValueThe original OCR valueString
LocalValueThe local value from the documentString
OCRLocalValueThe original OCR local valueString

Important Note: The authentication must be done before calling this action, for more information please refer to Authentication section.

Example URL

Request:

[GET] https://serviceurl/idscanenterprisesvc/journey/get?journeyId=13ccc9de-0e6c-4e18-8518-f7a7586cc316

Response:


Note: The structure of the response will be the same regardless of the document type but the extracted field list in this example is for demonstration purposes only; possible list of extracted fields depends on the document type being processed, list of possible extracted fields can be found under Annex2.

{
"JourneyId": "f1d6ea32-cec2-46ad-a041-4bd53e17d450",
"HighLevelResult": "Passed",
"HighLevelResultDetails": [
"DATEOFBITHCROSSCHECK:SKIPPED",
"DOCUMENTNUMBERCROSSCHECK:SKIPPED",
"DOCUMENTTYPECROSSCHECK:SKIPPED",
"EXPIRYDATECROSSCHECK:SKIPPED",
"FIRSTNAMECROSSCHECK:SKIPPED",
"LASTNAMECROSSCHECK:SKIPPED",
"PAPERDOCUMENTCROSSCHECK:SKIPPED",
"FACEMATCHVALIDATION:PASSED",
"CHIPPHOTOVALIDATION:PASSED",
"UNDERAGERULE:SKIPPED",
"DOCUMENTBACKSIDECHECK:SKIPPED",
"DOCUMENTBLOCKINGPOLICY:PASSED",
"DOCUMENTEXPIRY:SKIPPED",
"DOCUMENTSUPPORT:PASSED",
"DOCUMENTPROOFPOLICY:SKIPPED",
"DOCUMENTVALIDATION:PASSED",
"DOCUMENTACCEPTANCEPOLICY:PASSED"
],
"InitiatedDateTime": "2019-01-07T09:59:58.782926",
"ProcessedDocuments": [
{
"IssuingCountryCode": "DEU",
"IssuingCountryName": "Germany",
"DocumentCategory": "National Identification Card",
"DocumentType": "National Identification Card",
"DocumentName": "Germany-National Identification Card",
"DocumentSide": "Front",
"IsValidated": "true",
"ScanDateTime": "2019-01-07T09:59:58.782926",
"HighLevelResult": "Passed",
"ExtractedFields": [
{
"Name": "DocumentNumber",
"Value": "{{Extracted Document Number}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "FirstName",
"Value": "{{Extracted First Name}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "BirthDate",
"Value": "{{Extracted Birth Date}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "BirthPlace",
"Value": "{{Extracted Birth Place}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "LastName",
"Value": "{{Extracted Last Name}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "SecondLastName",
"Value": "{{Extracted Second Last Name}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "NationalityCode",
"Value": "DEU"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "NationalityName",
"Value": "German"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
},
{
"Name": "FullName",
"Value": "{{Full Name}}"
"OCRValue": "{{Extracted Document Number OCR Value}}"
"LocalValue": "{{Extracted Document Number Local Value}}"
"OCRLocalValue": "{{Extracted Document Number OCR Local Value}}"
}
],
"DocumentImages": [
{
"Role": "WhiteImage",
"Url":
"http://{{serviceUrl}}/idscanenterprisesvc/Search/GetImage?id=cd89dc83-0527-4827-ac28-9eeb8b340fea&role
=OutputWhiteImage"
},
{
"Role": "DigitalTamperingHeatmapImage",
"Url": "http://
{{serviceUrl}}/idscanenterprisesvc/Search/GetImage?id=cd89dc83-0527-4827-ac28-9eeb8b340fea&role=Digital
TamperingHeatmapImage"
},
{
"Role": "FacePortraitImage",
"Url": "http://
{{serviceUrl}}/idscanenterprisesvc/Search/GetImage?id=cd89dc83-0527-4827-ac28-9eeb8b340fea&role=FacePo
rtraitImage"
}
],
"DigitalTamperingValidator": "Passed"
}
],
"ReferenceNumber": "1000020072",
"AuthenticationToleranceLevel": "Default",
"AdditionalData": [
{
"Name": "UserName",
"Value": "username"
},
{
"Name": "BranchCode",
"Value": "Web Upload"
},
{
"Name": "RequiredJourneySteps",
"Value": "FRONTSIDE"
}
]
}

End of retrieval response example.

Notification Webhooks

On-boarding Suite also provides a set of webhooks that can be used to get notifications when certain events of interest happen. The consumer will need to implement the contract of the web hook operation in an http web service and configure the URL to this web service

The steps to make use of the notification web hook feature are as follows:

Step 1: Create an Http Web service that implements the service operations associated with the notifications you are interested in. For example if you are interested in getting notifications when a journey is finished, you need to implement the NotifyJourneyFinished operation in the web service available by calling:

POST <UrlOfNotificationWebHookServiceRoot>/OnJourneyFinised

Step 2: Publish the web service and make it accessible to On-boarding Suite backend. Configure the URL that On-boarding should locate the service in the setting item with the key “JourneyNotificationWebhookUrl” in the BackendSettings.xml file.

Supported notification webhooks are:

  • OnJourneyProgress notification

Invoked when an intermediate progress (events other than finishing the journey) occurs to a journey.

POST /OnJourneyProgress
ParameterDescriptionFormat
JourneyId EventThe identifier of the affected journey
A string code identifier that represents what event happened to the journey. This designates a step in the Capture Journey. Exhaustive list
of possible events that might occur will depend on the customisation
done on the On-boarding Suite configuration.

Some standard values common to most configurations are:
EntryStarted: Fired when a new entry will be captured.
EntryFinished: Fired when an entry finished capturing.
BacksideNeeded: Fired when switching to the backside of an entry.
CaptureRetry: Fired when the last capture was unsuccessful and a reattempt of capture is initiated.
A code value from
a set of values
represented
in a string.

OnJourneyFinished notification

Invoked when a journey is fully completed. Usually this is the place to host and fire any integration logic that will consume the journey data. As any point earlier than the journey finish will not guarantee the consistency and completeness of journey data.

POST /OnJourneyFinished
ParameterDescription
JourneyIdThe identifier of the affected journey

OnError notification
Invoked when an error occurs. If the error was associated with a specific journey, the relevant JourneyId is provided as well.

POST /OnJourneyError
Parameter
Description
JourneyId The identifier of the journey that was affected by the error if the error was related to a journey. A code value representing the error that occurred encoded as a string value.
ErrorCode Possible error codes are:
• ProcessingError
• ErrorSavingData
• ServerError
• JourneyViolation
ErrorDescription A text message describing the error
  • OnJourneyOverridden

invoked when journey overridden

POST /OnJourneyOverridden 
ParameterDescription
JourneyIdThe identifier of the affected journey

valDecision a boolean that represent the decision, true means accepted, while false is Rejected.

Was this page helpful?