Our StoryBlogPodcastAdoption Report
Documentation
Activate Account
Start typing to search…

Available 18013 Documents

This page documents the various 18013-compliant documents (and their namespaces/attributes) which can presently be verified through France Identité.

This information may be useful when providing a raw18013Request to Trinsic's API during Session creation.


Document TypeDescriptionPrimary NamespaceOther Namespace(s)
eu.europa.ec.eudi.pid.1EUDI PIDeu.europa.ec.eudi.pid.1N/A


eu.europa.ec.eudi.pid.1 Document

This document type is the core Person Identification Data (PID) credential in the EUDI framework.


eu.europa.ec.eudi.pid.1 Namespace

Below are all the fields found within the eu.europa.ec.eudi.pid.1 Namespace when working with eu.europa.ec.eudi.pid.1 Documents.

AttributeDescriptionMandatoryExample
given_nameCurrent first name(s), including middle name(s) where applicable, of the user to whom the person identification data relates.✅John
family_nameCurrent last name(s) or surname(s) of the user to whom the person identification data relates.✅Doe
birth_dateDay, month, and year on which the user was born.✅1990-12-31
birth_placeCountry (ISO 3166-1 alpha-2 code) or the municipality, city, town, village, state, province, district, or local area where the user was born.✅US
nationalityOne or more alpha-2 country codes as specified in ISO 3166-1 representing the nationality of the user.✅["DE"]
expiry_dateDate (and if possible time) when the person identification data expires.✅2030-12-31
issuing_authorityName of the administrative authority that issued the person identification data, or the ISO 3166 alpha-2 country code of the respective Member State.✅DE
issuing_countryAlpha-2 country code, as specified in ISO 3166-1, of the country or territory of the provider of the person identification data.✅DE
document_numberA number assigned by the provider that uniquely identifies the person identification data document.✅PID12345678
given_name_birthFirst name(s), including middle name(s), of the user at the time of birth.❌John
family_name_birthLast name(s) or surname(s) of the user at the time of birth.❌Smith
issuance_dateDate when the person identification data was issued or when its administrative validity period began.❌2025-01-01
trust_anchorURL where a machine-readable version of the trust anchor used for verifying the PID can be found.❌https://example.gov/pid
attestation_legal_categoryIndicates that a credential has been issued as a PID. Typically expected to contain the value PID.❌PID
issuing_jurisdictionCountry subdivision code of the jurisdiction that issued the credential, as specified in ISO 3166-2.❌DE-BE
location_statusLocation (such as a URL) where revocation or validity status information for the credential can be obtained.❌https://status.example
portraitFacial image of the user compliant with ISO 19794-5 or ISO 39794 specifications.❌<JPEG bytes>
sexSex value encoded according to the defined enumeration (0–9). Values 0,1,2,9 align with ISO/IEC 5218.❌1
email_addressEmail address of the user, formatted according to RFC 5322.❌[email protected]
mobile_phone_numberMobile phone number starting with + followed by country code and digits only.❌+15551234567
personal_administrative_numberUnique identifier assigned to the natural person by the issuing authority within its identification scheme.❌PN123456789
resident_addressFull address where the user currently resides or may be contacted.❌123 Main St, Berlin
resident_streetName of the street where the user resides.❌Main St
resident_house_numberHouse number of the residence, including any suffix or affix.❌123A
resident_cityMunicipality, city, town, or village where the user resides.❌Berlin
resident_stateState, province, district, or local area where the user resides.❌Berlin
resident_postal_codePostal code of the residence.❌10115
resident_countryCountry where the user resides as an ISO 3166-1 alpha-2 country code.❌DE


How To Make A Custom Request

🚧

Preview Feature

This feature is currently available as a Preview, and is intended for exploration, testing, and demos.

We intend to offer a more normalized, platform-wide feature to specify custom "scopes" for supported Providers in the future.

By default, your Verification Profile's configuration is used to create the 18013 request when you create a Session. However, you may wish to specify a custom request when creating a Session, allowing you to request any document(s), namespace(s), and attribute(s) that you wish.

Requirements:

  • You must be using Hosted or Direct Sessions
    • Widget Sessions do not currently support this functionality
  • You must be using a Backend SDK of version 3.0.2-preview1 or higher
    • This SDK supports the necessary preview_raw18013Request Provider-Specific Input field
    • If you are not using a Backend SDK, the JSON samples below will help you amend your request payloads.

To make a custom request, specify it in the Provider-Specific Input field (providerInput) when making a request, as so:

{
    "verificationProfileId": "...",
    "provider": "france-identite",

    // Other fields omitted

    "providerInput": {
        "france-identite": {
            "preview_raw18013Request": {
                // `documentRequests` is an array of requests, each describing a single document.
                // A credential which satisfies *any* of the requests can be used by the user.
                // Only a single credential is collected and returned.
                "documentRequests": [
                    {
                        // The document type to request -- see Trinsic's documentation 
                        // for a list of all valid document types for France Identité
                        "documentType": "eu.europa.ec.eudi.pid.1",

                        // A map of (nameSpaceName -> map(fieldName -> willRetain)), where:
                        // - nameSpaceName is a namespace within the document
                        // - fieldName is a field within the given namespace
                        // - willRetain indicates whether you intend to store the data beyond the scope of the immediate transaction
                        "nameSpaces": {
                            "eu.europa.ec.eudi.pid.1": {
                                // `given_name` is required, and will be stored by the requester
                                "given_name": true,

                                // `portrait` is required, and will NOT be stored by the requester
                                "portrait": false
                            }
                        }
                    }
                ]
            }
        }
    }
}
{
    "verificationProfileId": "...",
    "provider": "france-identite",
    "providerInput": {
        "france-identite": {
            "preview_raw18013Request": {
                "documentRequests": [
                    {
                        "documentType": "eu.europa.ec.eudi.pid.1",
                        "nameSpaces": {
                            "eu.europa.ec.eudi.pid.1": {
                                "given_name": true,
                                "portrait": false
                            }
                        }
                    }
                ]
            }
        }
    }
}

Updated 9 days ago