Trigger Bundle

This section describes how the Bundle/Workflow trigger API endpoint functions

How to use

To call the endpoint you will need to perform a HTTP POST request to the URL:

URL	API version
https://api.w2globaldata.com/case-kyc-check	1.4+

Example Request

Here is a full Bundle/Workflow trigger request and Response (SIS Plus service call) detailing every data option.

{
    "caseId":"15b49d9c-ce55-4adb-a241-6e4020207219",
    "bundle":"SPFPlusCheck",
    "Options": {
        "Sandbox": "False",
        "Key": "Value",
        "NameQueryMatchThreshold": "Accepted values: 80, 85, 90, 100",
        "DateOfBirthMatchThreshold": "Accepted values: -100 to 100"
    }
}

Request Breakdown

Description
The Bundle section states which bundle you are calling and is mandatory for every service call. A bundle is a collection of services which will be agreed with our Support team.
The identifier of the case to be used for the bundle call. This field is mandatory.
These are optional parameters for some extra fields not covered in the Data object. The whole section is optional. The full list of options that can be found at the Using the KYC endpoint page The most common use is to set Sandbox mode, where you can call the service and get standard responses. For further information, each service has examples of how to structure a call to the sandbox. NameQueryMatchThresholdandDateOfBirthMatchThreshold* options are explained further here: FAQs. These thresholds will only work with these services: SIS Plus SPF Plus PEPDesk Watchlist Check PEP and Sanction 006 W2-DATA-DISQUALIFIEDS-UK-008 W2 Data Ekyc SCANDI 025

Description

The Bundle section states which bundle you are calling and is mandatory for every service call. A bundle is a collection of services which will be agreed with our Support team.

The identifier of the case to be used for the bundle call. This field is mandatory.

These are optional parameters for some extra fields not covered in the Data object. The whole section is optional.

The full list of options that can be found at the Using the KYC endpoint page

The most common use is to set Sandbox mode, where you can call the service and get standard responses. For further information, each service has examples of how to structure a call to the sandbox.

*NameQueryMatchThresholdandDateOfBirthMatchThreshold** options are explained further here: FAQs. These thresholds will only work with these services:
SIS Plus
SPF Plus
PEPDesk
Watchlist Check
PEP and Sanction 006
W2-DATA-DISQUALIFIEDS-UK-008
W2 Data Ekyc SCANDI 025

Example Response

{
    "clientReference": "CaseReference",
    "results": {
        "spfPlusCheckResult": {
            "matchResults": [
                {
                    "matchType": "Person",
                    "name": "Theresa Jones",
                    "nameMatchScore": 90,
                    "profileId": "SANC-d69d6314-4ab0-90db-efa3-735eb3f2a283"
                },
                {
                    "matchType": "Unknown",
                    "name": "Theresa Harrison",
                    "nameMatchScore": 80,
                    "profileId": "SANC-4edac9cc-3ee8-f7dc-4ec3-2fa7df3401bd"
                }
            ]
        }
    },
    "transaction": {
        "interpretResult": "NotApplicable",
        "serviceCallReference": "b3a13e17-1fbf-424a-81f9-1c1c38d43a1a",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "SPFPlusCheck",
                "serviceInterpretResult": "MultipleResults",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }

Response Breakdown

Client provided data

This section simply reflects back information that was submitted in the API call.

Property	Description
ClientReference	This reflects back the client reference that was supplied in the request.
ClientSubaccount	An optional reference to identify which of your client accounts this call was made for.
ClientUser	An optional reference to identify which individual user made this call. For future compatibility with nCino Identity Solutions products we suggest this value should be the user's email address.
RefersToServiceCallReference	Links this call to a previous call by specifying the previous ServiceCallReference.

Transaction Information

This section contains the interpret result for the whole bundle, the service call reference and a section of metadata for each service.

Property	Description
InterpretResult	The validation result of the Interpret function. 1. Pass - The information supplied to the bundle passed validation. 2. Fail- The information supplied to the bundle failed validation. 3. Inconclusive- It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation. 4. NoInterpretPerformed - No interpret was performed in this case. Check the other information returned by the services to determine why. 5. NotApplicable - Interpret is not enabled for this bundle.
ServiceTransactions	A collection of ServiceTransactionInformation objects. See below
ServiceCallReference	A unique reference for this service call.

Property

Description

InterpretResult

The validation result of the Interpret function.

1. Pass - The information supplied to the bundle passed validation.
2. Fail- The information supplied to the bundle failed validation.
3. Inconclusive- It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation.
4. NoInterpretPerformed - No interpret was performed in this case. Check the other information returned by the services to determine why.
5. NotApplicable - Interpret is not enabled for this bundle.

ServiceTransactions

A collection of ServiceTransactionInformation objects. See below

ServiceCallReference

A unique reference for this service call.

Service Transaction Information

Every service that is called will return one of these:

Property	Description
Service	The service that was invoked.
ServiceInterpretResult	The validation result of the service interpret function. 1. Pass - The query data resulted in a pass. 2. Fail - The query data resulted in a failure. 3. Inconclusive - The query data resulted in an inconclusive outcome. 4. NoResults - The query data returned no results. 5. OneResult - The query data returned a single result. 6. MultipleResults - The query data returned multiple results. 7. NotApplicable - Interpret is not applicable to the call or wasn't enabled. 8. NotPerformed - An error prevented this result from being categorised.
ServiceTransactionResult	he validation result for service transaction. 1. Success - The service executed successfully. 2. SuccessNoResults - The service executed successfully but no results were generated. 3. SuccessIncompleteResults - The service executed successfully but too many results were generated to return them all, so the results have been truncated. 4. MultipleChoices - The service could not continue as there are multiple choices available and one of them must be selected or the query must be submitted with more concise information in order to complete execution. 5. ClientErrorInsufficientInformation - There was insufficient information for the service to execute. Check that all of the required fields for the service were supplied. 6. NotExecutedDueToPreviousHalt - The service was not executed because a previous service in the bundle triggered a halt. 7. ServerErrorGeneralError - A general error occurred on the server trying to run the service.
ServiceTransactionResultMessage	The message associated with the ServiceTransactionResult if applicable. The ServiceTransactionResultMessage is usually null, but in some cases may provide some insight into the ServiceTransactionResult. For example, if a service returns SuccessIncompleteResults the ServiceTransactionResultMessage may contain an explanation of why, such as there being a limit of 100 results per query. There is no standard across services for this field so it should not be relied upon, instead it is better to use it for debugging or additional information and rely on the ServiceTransactionResult which has consistent behaviour.
ValidationResult	The validation result... 1. Pass - The information supplied to the service passed validation 2. Fail - The information supplied to the service failed validation. 3. Inconclusive - It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation. 4. NoValidationPerformed - No validation was performed in this case. Check the other information returned by the service to determine why. 5. NotApplicable - The service is not a service that performs validation and therefore validation is not applicable.
ServiceValidationDetails	This field provides information about the pre-execution validation step and should be read in conjunction with the ValidationResult field.
HaltTriggered	True if the service halted after this service