Webhook

VX will fire a webhook to your defined endpoint after each components execution through the journey.

POST [YOUR_ENDPOINT}

200: OK

{
	"status": "PASS",
	"request_id": "f6bc8e10-a6ab-4497-9ab0-0c69a022bda8",
	"input": {
		"fn": "Barbara",
		"ln": "Miller",
		"addr": "123 Main St",
		"city": "Stratford",
		"state": "CT",
		"zip": "06614",
		"dob": "19720221",
		"email": "[e-mail]",
		"reference": "a unique value to idnetify the customer",
		"additionalData": {
			"any_key_1": "any_value",
			"any_key_2": "any_value"
		}
	},
	"journey": {
		"id": "06276cd6-0a30-428b-825c-2af90f4e66b2",
		"duration": 21000,
		"components": {
			"history": {
				"0": {
					"name": "PhoneMatch",
					"id": "1d91930e-a996-4af1-a47a-f227cc8e5d6c",
					"intialized": "2022-08-26T12:00:00",
					"completed": "2022-08-26T12:00:15",
					"verification_api": {
						"0": {
							"timestamp": "2022-08-26T12:00:14",
							"confirmation": 12345345,
							"service": "PhoneMatch5.0",
							"action": "PASS",
							"detail": "ALL CHECKS PASSED",
							"issues": [],
							"data": []
						}
					}
				}
			}

		}
	}
}

Payload

{
    "fn": "John",
    "ln": "Smith",
    "addr": "123 Main St",
    "city": "Stratford",
    "state": "CT",
    "zip": "06614",
    "dob": "19880521",
    "email": "[e-mail]",
    "reference": "12345-test",
    "status": "PENDING",
    "additionalData": {
        "value_1": "test1",
        "value_2": "test2"
    },
    "dcams_plus": {
        "document_data": {
            "FirstName": "LOUISA",
            "LastName": "SAMPLE",
            "MiddleName": "ANNA",
            "FullAddress": "109 S FOSTER RD, BATON ROUGE, LA, 70808-0000",
            "Address": "109 S FOSTER RD",
            "City": "BATON ROUGE",
            "State": "LA",
            "Zip": "70808-0000",
            "DateOfBirth": "19720629",
            "Height": "5-08",
            "Sex": "F",
            "EyeColor": "BRN",
            "DocumentNumber": "003009381",
            "IssueDate": "20140714",
            "ExpirationDate": "20300629",
            "CountryCode": "USA", // (ISO Alpha 2 or 3)
            "DocumentType": "DRIVERS LICENSE" // other values are PASSPORT, IDENTITY CARD and UNKNOWN
        },
        "confirmation": 92480850,
        "action": "REVIEW",
        "issues": ["DOB DOES NOT MATCH DOCUMENT", "FIRST NAME DOES NOT MATCH DOCUMENT"],
        "detail": "TRANSACTION REQUIRES FURTHER ATTENTION"
    },
    "storage": {
            "success": false
      }
}