This section provides API-level reference material for eKYC Prefill. Use these pages to understand how a lookup works, request and response semantics, the sources and identifiers available per country, and the data each source returns.
Info
This is different than eKYC Reference.
For an overview of how to configure eKYC Prefill in your Dashboard, see eKYC Prefill Dashboard configuration.
How a lookup works
The end user provides the identifiers the configured source needs. Then Incode:
- Checks that the Session contains this module and that the organization is enabled for its source.
- Validates the identifiers against the source's requirements, before any lookup is made.
- Looks up the person in the source for the module's country.
- Returns the person's data together with a
checkStatusand stores the result with the Session.
Check statuses
| Value | Meaning |
|---|---|
| pass | The person was found and their data is returned. |
| partialPass | The person was found, but one of the source's checks was not met. Data is returned. |
| fail | No person data was returned. A message says why. Also covers answers where the source found more than one possible person. |
| inconclusive | BR_PREFILL source only. The source could not decide. No person data is returned. |
A pass with no person data and a Minor or AgeUnknown reason code means the answer was withheld, because the person found is under the source's minimum age or their age could not be established. See Minimum age in the eKYC Pre-fill API Reference.
Treat an unrecognized status as fail.
What's in this section
- eKYC Prefill API Reference explains the request, response, and error schemas for
POST /omni/externalVerification/ekyc-prefill, including the minimum age rule and lookups per session. - eKYC Prefill Coverage lists the countries and sources Incode supports, the identifiers each source needs, the data each source returns, and the lookup limit per source.