Documentation
DocumentationRecipesAPI Referenceincode.com

Fetch eKYC Data

An introduction to fetching onboarding eKYC data

Suggest Edits

What is eKYC data?

Customers often integrate our eKYC input forms directly into their end-user experiences. As a result, customers want to have the opportunity to save and collect the original form input. The eKYC data for an onboarding contains all of the information that was submitted during the eKYC onboarding form. This includes all the textual information submitted (eg. Name, Address, etc.)

How is eKYC data fetched?

To fetch eKYC data for a given onboarding session, you will need to pass the session's unique interview ID to the API endpoint.

Direct API approach

📘

API Authentication

All endpoints require authentication headers to be specified as stated in Incode API Documentation

eKYC fetch input

GET /externalVerification/ekyc/session/{interviewId}

You can retrieve the session IDs by navigating to the sessions tab within your dashboard.


Sample Response

{
    "userData": {
        "plugins": [],
        "source": "US_CREDIT_BUREAU_1",
        "firstName": "xxx",
        "surName": "xxx",
        "email": "[email protected]",
        "street": "XXX XX AVE",
        "houseNo": "XX",
        "postalCode": "XXXXX",
        "countryCode": "US",
        "phone": "+1408XXXXXXX",
        "state": "CA",
        "city": "SAN FRANCISCO",
        "ssn": "123456789",
        "dateOfBirth": "YYYY-MM-DD"
    },
    "riskData": {
        "level": "medium",
        "verifications": {
            "phoneCarrier": "Multiple OCN Listing",
            "phoneLevel": "very_high",
            "taxIdLevel": "medium",
            "taxIdStateMatch": "exact",
            "emailDomainLevel": "low",
            "phoneLineType": "Landline",
            "taxIdMatch": "exact",
            "taxIdDobMatch": "exact",
            "taxIdNameMatch": "fuzzy",
            "taxIdAddressMatch": "nomatch",
            "addressRiskLevel": "low",
            "emailLevel": "medium"
        },
        "reasonCodes": [
            {
                "key": "addressRiskLevel",
                "reasonCodes": [
                    {
                        "reasonCode": "A70SS",
                        "description": "Tracking data indicates that over 70% of mailpieces sent to this address were delivered successfully and recent mailings were also successful."
                    }
                ]
            },
            {
                "key": "taxIdLevel",
                "reasonCodes": [
                    {
                        "reasonCode": "TSAC",
                        "description": "Current Address Conflict"
                    },
                    {
                        "reasonCode": "TANO",
                        "description": "Current Address Not On-file"
                    },
                    {
                        "reasonCode": "TMAI",
                        "description": "Multiple address inconsistencies in last 7 days and SSN seen with different phones in last 90 days"
                    },
                    {
                        "reasonCode": "TPSMT",
                        "description": "Phone seen multiple times in last 90 days with different last names"
                    },
                    {
                        "reasonCode": "TPDNV",
                        "description": "One or more PII data elements not verified"
                    }
                ]
            },
            {
                "key": "customer",
                "reasonCodes": [
                    {
                        "reasonCode": "PRSA",
                        "description": "This number has risky static attributes (like VOIP phone type or being on a blocklist) -"
                    },
                    {
                        "reasonCode": "EANI",
                        "description": "Not enough information was found for the provided email address to determine a risk assessment"
                    },
                    {
                        "reasonCode": "TSAC",
                        "description": "Current Address Conflict"
                    },
                    {
                        "reasonCode": "TANO",
                        "description": "Current Address Not On-file"
                    },
                    {
                        "reasonCode": "TMAI",
                        "description": "Multiple address inconsistencies in last 7 days and SSN seen with different phones in last 90 days"
                    },
                    {
                        "reasonCode": "TPSMT",
                        "description": "Phone seen multiple times in last 90 days with different last names"
                    },
                    {
                        "reasonCode": "TPDNV",
                        "description": "One or more PII data elements not verified"
                    }
                ]
            }
        ]
    }
}

Updated 3 months ago