v1

latestOpenAPI 3.1.02026-07-2423390.9 KB

Get Journey Result

get/v2/get/{JOURNEY_ID}

Path parameters

JOURNEY_IDstring required

The journey id

Response

200

journey_idstring
customer_idstring
reference_numberstring
system_decisionstring
{"stackTrail":"paths:/v2/get/{JOURNEY_ID}:get:responses:200:content:application/json:schema:properties:manual_decision","oasType":"schema","type":"unknown"}
final_decisionstring
journey_definition_idstring
flow_idstring
start_timestring
end_timestring
model_versionstring
screening_checksobject

Example response

{
  "journey_id": "6569a1a20bbb191bf2628841",
  "customer_id": "0c7a806e-0683-4736-8063-13a425d32bdf",
  "system_decision": "Refer",
  "final_decision": "Refer",
  "journey_definition_id": "0c7a806e-0683-4736-8063-13a425d32bdf",
  "flow_id": "0c7a806e-0683-4736-8063-13a425d32bdf",
  "start_time": "2023-12-01T09:04:34.356457",
  "end_time": "2023-12-01T09:06:22.329770",
  "model_version": "4.0",
  "documents": {
    "0": {
      "step_title": "Photo ID",
      "progress": "Completed",
      "document_type": "Passport",
      "issuing_country": "United Kingdom",
      "issuing_country_code": "GBR",
      "extracted_fields": {
        "Full Name": {
          "value": "*********",
          "type": "string"
        },
        "First Name": {
          "value": "********",
          "type": "string"
        },
        "Last Name": {
          "value": "*******",
          "type": "string"
        },
        "Sex": {
          "value": "*********",
          "type": "string"
        },
        "Birth Date": {
          "value": "*********",
          "type": "string"
        },
        "Issue Date": {
          "value": "*********",
          "type": "string"
        },
        "Expiry Date": {
          "value": "********",
          "type": "string"
        },
        "Document Number": {
          "value": "********",
          "type": "string"
        },
        "Birth Place": {
          "value": "********",
          "type": "string"
        },
        "Nationality Code": {
          "value": "***",
          "type": "string"
        },
        "Nationality": {
          "value": "**********",
          "type": "string"
        },
        "Issuing Authority": {
          "value": "*******",
          "type": "string"
        },
        "Machine Readable Zone": {
          "value": "****************",
          "type": "string"
        }
      },
      "validation_result": {
        "validation_checks": [
          {
            "name": "Document Expired",
            "description": "Checks the expiration of the document.",
            "result": "Passed",
            "result_description": "The document has not expired."
          }
        ],
        "validation_outcome": "Passed"
      },
      "images": {
        "front_image_path": "025a67acd0d34658d9e7db8961abeb86",
        "front_cropped_image_path": "b23d99613df2345c4d57b82f12891c29",
        "portrait_image_path": "b23d99613df2345c4d57b82f12891c29"
      }
    }
  },
  "selfie": {
    "status": "Complete",
    "is_live": true,
    "image_path": "b23d99613df234234567b82f12891c29"
  },
  "rule_results": {
    "unrecognized_document": {
      "description": "Confirms that the submitted ID documents are recognised and supported.",
      "information": "Verifies the recognition of the submitted documents as a supported document type and the ability to fully authenticate them.",
      "name": "Recognised Document",
      "result": "Passed",
      "tips": "Failure of this check indicates that the system did not recognise (classify) the submitted document(s). This may occur if a valid document is significantly worn or damaged or if the document is of a new or different type that is not yet supported by the document library. This may also happen if the document is fraudulent. Some fraudulent documents are so different from authentic documents that they will not be recognized. You should consider examining the document manually in this case and contact support for further expert guidance.",
      "details": [
        {
          "title": "Photo ID",
          "result_description": "The document was recognised as a supported document type.",
          "reference_object": {
            "object_key": "documents"
          },
          "result": "Passed"
        }
      ]
    },
    "document_validation": {
      "description": "Confirms the authenticity of the submitted documents, likely being free of any evidence of manipulation.",
      "information": "Verifies the authenticity of the submitted documents which are likely free from manipulation.",
      "name": "Authentic Document",
      "result": "Passed",
      "tips": "This check may fail if there is a strong evidence of manipulation, or if of the submitted document is not physically present (captured from screen or a photocopy). It may also fail if the document is of very low quality with significant glare / blur. Inspect the document for any evidence of manipulation to decide on the authenticity of the presented document.",
      "details": [
        {
          "title": "Photo ID",
          "result_description": "All submitted documents seem to be authentic.",
          "reference_object": {
            "object_key": "documents"
          },
          "result": "Passed"
        }
      ]
    },
    "expired_document": {
      "description": "Confirms that the documents provided are not expired",
      "information": "Verifies that the document's expiration date occurs after the date of the application.",
      "name": "Expired Document",
      "result": "Passed",
      "tips": "Check the type of the document provided and the expiry date. In some rare cases the expiry date might have been misread.",
      "details": [
        {
          "title": "Photo ID",
          "result_description": "Document expiry date is after the date of the application.",
          "reference_object": {
            "object_key": "documents"
          },
          "result": "Passed"
        }
      ]
    },
    "proof_policy": {
      "description": "Confirms that the document provided is of the accepted type for each particular journey step.",
      "information": "Checks the type of the document supplied against a list of allowed document types and/or issuing countries configured as accepted on each particular journey step. For example, if a journey step is configured to accept a Driving Licence only but the user provided a Passport, this check would fail.",
      "name": "Accepted Documents Policy",
      "result": "Passed",
      "tips": "Check the type of the document provided and the issuing country. Confirm if they are accepted for this type of application.",
      "details": [
        {
          "title": "Photo ID",
          "result_description": "Document is confirmed to be one of the accepted types:\n\t- The front of Identity Card document.\n\t- The photo page of Passport document.\n\t- The front of Residence Permit document.",
          "reference_object": {
            "object_key": "documents"
          },
          "result": "Passed"
        }
      ]
    },
    "under_age": {
      "description": "Verifies that the applicant is over 45 years old.",
      "information": "This check verifies that the applicant is over 45 years old.",
      "name": "Under Age",
      "result": "Failed",
      "tips": "If this check fails, check the date of birth on the ID Document provided by the applicant.",
      "details": [
        {
          "title": "Photo ID",
          "result_description": "The applicant is under 45 years old.",
          "reference_object": {
            "object_key": "documents"
          },
          "result": "Failed"
        }
      ]
    },
    "selfie_liveness": {
      "description": "Verifies that the selfie photo supplied in the onboarding journey is live.",
      "information": "This check verifies that the selfie photo captured in the selfie step of the onboarding journey is live and of an applicant that is physically present during the verification process.",
      "name": "Selfie Liveness",
      "result": "Passed",
      "tips": "If this check fails, check the selfie photo provided by the applicant.",
      "details": [
        {
          "title": "Selfie",
          "result_description": "Selfie photo appears to be live.",
          "reference_object": {
            "object_key": "selfie",
            "instance_key": 10
          },
          "result": "Passed"
        }
      ]
    }
  },
  "applicant": {
    "applicant_id": "6569a11234d345caf2628840",
    "full_name": "***********",
    "birth_date": "****-**-**",
    "profile_image_path": "62776f0331234bcda4a3220d4da35e04"
  },
  "aml": {
    "applicability": "Disabled"
  }
}
All 23 operations