General reference, eKYC Reference / eKYC Coverage

Portugal

Portugal eKYC verification matches submitted individual data against Portugal's phone register as the source of truth. See the eKYC API Reference for common response semantics that apply across all sources.

Available sources

Source API source string Description
Portugal Phone Register PT_PHONE_REGISTER Verifies submitted data against Portugal's phone register.
Portugal Civil Register + Credit + Telco PT_CIVIL_REG_CREDIT_TELCO Verifies submitted data against Portugal's civil register, consumer credit, and phone register.

Portugal Phone Register

Request parameters

Parameter Required Description
source Mandatory Must be PT_PHONE_REGISTER.
country Mandatory Must be PT.
firstName Mandatory First name of the individual. All given names in one field (for example, João Pedro). There is no separate compound-name splitting. Diacritics (ã, ç, é, ê, ô, ó, and so on) are supported and kept as provided. Must not contain digits.
surName Mandatory Last name of the individual. All surnames in one field (for example, Gonçalves Ferreira). There is no separate compound-name splitting. Diacritics (ã, ç, é, ê, ô, ó, and so on) are supported and kept as provided. Must not contain digits.
phone Optional Portuguese phone number including country code. Format: +351 or 351 followed by 9 digits starting with 9 (mobile) or 2 (landline). For example, 351912345678 or +351912345678. Spaces and dashes are allowed. The 9-digit number alone, an incorrect country code, or a number starting with any other digit returns a 400 error.
middleName Optional Middle name of the individual. Not included in fullNameMatch.
gender Optional Accepted values are m or f.
street Optional Street name and house number in one field, street first (for example, Rua das Mimosas 99).
city Optional City of the individual's address (for example, Vila Nova de Gaia).
postalCode Optional Portuguese postal code. Format: XXXX-XXX or 7 digits, first digit must be 1 to 9 (for example, 4430-458 or 4430458). A postal code starting with 0 is not accepted.

Sample request

{
    "plugins": ["kyc"],
    "source": "PT_PHONE_REGISTER",
    "firstName": "John",
    "middleName": "Example",
    "surName": "Doe",
    "gender": "m",
    "street": "Rua Example 1",
    "city": "Lisboa",
    "postalCode": "1100-048",
    "country": "PT",
    "phone": "351900000000"
}

Response fields

Portugal Phone Register anchors verification on full name, and then verifies phone number and address. See the eKYC API Reference for common match field definitions and status values.

Field Statuses Description
firstNameMatch exact, Approximate Match, nomatch Matches first name submitted against the value in the source of truth.
lastNameMatch exact, Approximate Match, nomatch Matches last name submitted against the value in the source of truth.
middleNameMatch exact, fuzzy, nomatch, nodata Matches middle name submitted against the value in the source of truth. Shown as a standalone field and not included in fullNameMatch. nodata when not submitted.
fullNameMatch exact, Approximate Match, nomatch, nodata Composite match derived from firstNameMatch and lastNameMatch. See below for calculation logic.
genderMatch exact, fuzzy, nomatch, nodata Matches gender submitted against the value in the source of truth. nodata when not submitted.
streetMatch exact, Approximate Match, nomatch, nodata Matches street address submitted against the value in the source of truth. nodata when not submitted.
cityMatch exact, Approximate Match, nomatch, nodata Matches city submitted against the value in the source of truth. nodata when not submitted.
postalCodeMatch exact, Approximate Match, nomatch, nodata Matches postal code submitted against the value in the source of truth. nodata when not submitted.
fullAddressMatch exact, Approximate Match, nomatch, nodata Composite match derived from streetMatch, cityMatch, and postalCodeMatch. See below for calculation logic.
phoneMatch exact, Approximate Match, nomatch, nodata Matches phone number submitted against the value in the source of truth.
overallLevel low, medium, high Overall risk level. See below for calculation logic.

Info

Any field that was not submitted counts as nodata in all composite logic, regardless of what the source of truth returns for it.

overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name, phone number, and address:

  • low when fullNameMatch is exact AND at least one of the following is true: phoneMatch is exact, cityMatch is exact, postalCodeMatch is exact, or streetMatch is exact or Approximate Match.
  • high when fullNameMatch is nomatch OR all of the following are nomatch or nodata: streetMatch, cityMatch, postalCodeMatch, and phoneMatch.
  • medium for all other combinations.

fullNameMatch calculation

fullNameMatch is derived from firstNameMatch and lastNameMatch. middleNameMatch is not included.

  • exact when both names are exact, or one is exact and the other is Approximate Match, and middle name is exact, Approximate Match, or nodata.
  • Approximate Match when both names are Approximate Match.
  • nomatch when both names are nomatch. A surname-only match does not count.
  • nodata when both names are nodata.

fullAddressMatch calculation

fullAddressMatch is derived from streetMatch, cityMatch, and postalCodeMatch, evaluated in the following order:

  • exact when streetMatch is exact or Approximate Match AND (cityMatch is exact OR postalCodeMatch is exact).
  • nodata when all of streetMatch, cityMatch, and postalCodeMatch are nodata.
  • nomatch when streetMatch is nomatch or nodata AND cityMatch is nomatch or nodata AND postalCodeMatch is nomatch or nodata.
  • Approximate Match for any other combination.

Sample response

{
    "kyc": [
        { "key": "firstNameMatch",   "status": "exact" },
        { "key": "lastNameMatch",    "status": "exact" },
        { "key": "middleNameMatch",  "status": "exact" },
        { "key": "fullNameMatch",    "status": "exact" },
        { "key": "genderMatch",      "status": "exact" },
        { "key": "streetMatch",      "status": "exact" },
        { "key": "cityMatch",        "status": "exact" },
        { "key": "postalCodeMatch",  "status": "exact" },
        { "key": "fullAddressMatch", "status": "exact" },
        { "key": "phoneMatch",       "status": "exact" },
        { "key": "overallLevel",     "status": "low" }
    ]
}

Portugal Civil Register + Credit + Telco

Request parameters

Parameter Required Description
source Mandatory Must be PT_CIVIL_REG_CREDIT_TELCO.
country Mandatory Must be PT.
firstName Mandatory First name of the individual. All given names in one field (for example, João Pedro). Diacritics (ã, ç, é, ê, ô, ó, and so on) are supported and kept as provided. Must not contain digits.
surName Mandatory Last name of the individual. All surnames in one field (for example, Gonçalves Ferreira). Diacritics (ã, ç, é, ê, ô, ó, and so on) are supported and kept as provided. Must not contain digits.
phone Mandatory Portuguese phone number including country code. Format: +351 or 351 followed by 9 digits starting with 9 (mobile) or 2 (landline). For example, 351912345678 or +351 912 345 678. Spaces and dashes are allowed. The 9-digit number alone, an incorrect country code, unsupported characters (such as parentheses), or a number starting with any other digit returns a 400 error.
street Optional Street name and house number in one field, street first (for example, Rua das Mimosas 99). Do not include floor or flat details.
city Optional City of the individual's address (for example, Vila Nova de Gaia).
postalCode Optional Portuguese postal code. Format: XXXX-XXX or 7 digits, first digit must be 1 to 9 (for example, 4430-458 or 4430458).
dateOfBirth Optional Format: yyyy-mm-dd. Must be a date in the past.

Sample request

{
    "plugins": ["kyc"],
    "source": "PT_CIVIL_REG_CREDIT_TELCO",
    "firstName": "John",
    "surName": "Doe",
    "street": "Rua Example 1",
    "city": "Lisboa",
    "postalCode": "1100-048",
    "country": "PT",
    "dateOfBirth": "2000-01-01",
    "phone": "351900000000"
}

Response fields

Portugal Civil Register + Credit + Telco anchors verification on full name and phone number, then verifies date of birth and address. See the eKYC API Reference for common match field definitions and status values.

Field Statuses Description
firstNameMatch exact, fuzzy, nomatch Matches first name submitted against the value in the source of truth.
lastNameMatch exact, fuzzy, nomatch Matches last name submitted against the value in the source of truth.
fullNameMatch exact, fuzzy, nomatch, nodata Composite match derived from firstNameMatch and lastNameMatch.
dobMatch exact, fuzzy, nomatch, nodata Matches date of birth submitted against the value in the source of truth. nodata when not submitted.
streetMatch exact, fuzzy, nomatch, nodata Matches street address submitted against the value in the source of truth. nodata when not submitted.
cityMatch exact, fuzzy, nomatch, nodata Matches city submitted against the value in the source of truth. nodata when not submitted.
postalCodeMatch exact, fuzzy, nomatch, nodata Matches postal code submitted against the value in the source of truth. nodata when not submitted.
fullAddressMatch exact, fuzzy, nomatch, nodata Composite match derived from streetMatch, cityMatch, and postalCodeMatch.
phoneMatch exact, fuzzy, nomatch, nodata Matches phone number submitted against the value in the source of truth.
overallLevel low, medium, high Overall risk level. See below for calculation logic.

Info

Any field that was not submitted counts as nodata in all composite logic, regardless of what the source of truth returns for it.

overallLevel calculation

overallLevel is calculated based on the risk associated with the submitted full name and at least one verified attribute:

  • low when fullNameMatch is exact AND at least one of the following is true: phoneMatch is exact, cityMatch is exact, postalCodeMatch is exact, dobMatch is exact, or streetMatch is exact or fuzzy.
  • high when fullNameMatch is nomatch OR all of the following are nomatch or nodata: streetMatch, cityMatch, postalCodeMatch, dobMatch, and phoneMatch.
  • medium for all other combinations.

Contact your Incode representative to customize the overallLevel calculation for your use case.

Sample response

{
    "kyc": [
        { "key": "firstNameMatch",   "status": "exact" },
        { "key": "lastNameMatch",    "status": "exact" },
        { "key": "fullNameMatch",    "status": "exact" },
        { "key": "dobMatch",         "status": "exact" },
        { "key": "streetMatch",      "status": "nomatch" },
        { "key": "cityMatch",        "status": "exact" },
        { "key": "postalCodeMatch",  "status": "exact" },
        { "key": "fullAddressMatch", "status": "fuzzy" },
        { "key": "phoneMatch",       "status": "exact" },
        { "key": "overallLevel",     "status": "low" }
    ]
}

Was this page helpful?