KYC Check Response

This describes the shape of the KYC Check response

KYC Check Response Example

 Here is a full KYC Check response for a SIS Plus service call.

{
  "clientReference": "123-456-789",
  "results": {
    "sisPlusCheckResult": {
      "matchResults": [
        {
          "matchType": "Person",
          "name": "Robert Gabriel MUGABE",
          "nameMatchScore": 85,
          "profileId": "SANC-d28cdbbd-5c0e-1a1b-4c1c-88a6b5790e84"
        },
        {
          "matchType": "Person",
          "name": "Robert Gabriel MUGABE",
          "nameMatchScore": 85,
          "profileId": "SANC-081d73e2-b1cd-baeb-176b-cf1607b75383"
        },
        {
          "matchType": "Unknown",
          "name": "Robert Gabriel Mugabe",
          "nameMatchScore": 85,
          "profileId": "SANC-dac80327-376e-6784-e793-3d39904726f4"
        },
        {
          "matchType": "Person",
          "name": "MUGABE Robert Gabriel",
          "nameMatchScore": 80,
          "profileId": "SANC-9763b970-f325-77bc-5c7e-46d7c18b3f01"
        }
      ]
    }
  },
  "transaction": {
    "interpretResult": "NotApplicable",
    "serviceCallReference": "8bb44731-9103-47b2-979e-f27c69f9d68b",
    "serviceTransactions": [
      {
        "haltTriggered": false,
        "service": "SISPlusCheck",
        "serviceInterpretResult": "MultipleResults",
        "serviceTransactionResult": "Success",
        "serviceTransactionResultMessage": "This call was generated using sandbox mode",
        "validationResult": "Pass"
      }
    ]
  }
}

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 W2 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 meta data for each service.

Property Details
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 Details
Service The service that was invoked.
ServiceInterpretResult
  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
  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
  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