For the complete documentation index, see llms.txt

Czech Bank iD attributes in Authentication REST API

This page contains information about the user attributes that you can request and retrieve from Czech Bank iD when using the Signicat Authentication REST API as an authentication protocol.

Attributes table

For the complete documentation index, see llms.txt

Czech Bank iD provides the following data:

AML verification settings

If you set profile.verification to Required when configuring your app in the Czech Bank iD Dashboard, then you must specify at least one of the equivalent attributes (bankidCzVerificationProcess and bankidCzVerificationTrustFramework) in your authentication request.

Examples

Request example

To create a session using the Authentication REST API, you send a POST request to the Create a new session endpoint of the Authentication REST API. This is https://api.signicat.com/auth/rest/sessions.

You define the parameters of the session in the payload of the request. For example:

{
    "allowedProviders": [
        "bankid-cz"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "address",
        "bankidCzIdCard",
        "bankidCzLimitedLegalCapacity",
        "bankidCzPaymentAccounts",
        "bankidCzPep",
        "bankidCzTitlePrefix",
        "bankidCzTitleSuffix",
        "bankidCzUpdatedAt",
        "bankidCzVerificationProcess",
        "bankidCzVerificationTrustFramework",
        "countryOfBirth",
        "dateOfBirth",
        "18OrOlder",
        "email",
        "firstName",
        "gender",
        "lastName",
        "maritalStatus",
        "middleName",
        "name",
        "nationality",
        "nin",
        "phoneNumber",
        "placeOfBirth",
        "idpId"
	],
    "callbackUrls": {
        "success": "https://example.com/success",
        "abort": "https://example.com/abort",
        "error": "https://example.com/error"
	},
    "requestDomain": "<YOUR_SIGNICAT_DOMAIN>"
}

Response example

The following is an example of a response showing the end-user information attributes:

{
    "id": "ab...d7-b5cb-402e-a989-d...57",
    "accountId": "a-spge-zRW...XB",
    "authenticationUrl": "https://<YOUR_SIGNICAT_DOMAIN>/broker/sp/external-service/login?messageId=0ef7112f-d292-b042-a289-e42b66f02424&transactionId=3f7ea0c8-97ae-c547-ad5f-a62492ceb0a2",
    "status": "SUCCESS",
    "provider": "bankid-cz",
    "subject":
    {
        "id": "2chXmU2kWsMJWZ4x-mCxcbiaKSkSVNDiglqp8nBIP5s=",
        "idpId": "fed17912-aa8b-4f88-8c0f-9eb2b909d07f",
        "name": "Jan Novák",
        "firstName": "Jan",
        "lastName": "Novák",
        "dateOfBirth": "1970-08-01",
        "email": "J.novak@example.com",
        "nin":
        {
            "value": "7008018556",
            "issuingCountry": "CZ",
            "type": "PERSON"
        },
        "placeOfBirth": "Praha 4",
        "countryOfBirth": "CZ",
        "nationality": "AT, CZ",
        "maritalStatus": "MARRIED",
        "bankidCzPep": "false",
        "bankidCzLimitedLegalCapacity": "false",
        "bankidCzPaymentAccounts": "CZ9530300000000999999998, CZ4830300000000999999971",
        "bankidCzUpdatedAt": "1622543116",
        "bankidCzIdCard": "123456789",
        "bankidCzVerificationProcess": "45244782",
        "bankidCzVerificationTrustFramework": "cz_aml",
        "phoneNumber": "+420123456789",
        "gender": "M",
        "address": "PERMANENT_RESIDENCE, Dlouhá, 2, 609, Praha, 11000, CZ, 21722315",
        "addressFormatted":
        {
            "FullAddress": "PERMANENT_RESIDENCE, Dlouhá, 2, 609, Praha, 11000, CZ, 21722315",
            "Street": "Dlouhá",
            "HouseNumber": "609",
            "City": "Praha",
            "PostalCode": "11000",
            "Country": "CZ"
        }
    },
    "callbackUrls":
    {
        "success": "https://example.com:443/success?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557",
        "abort": "https://example.com:443/abort?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557",
        "error": "https://example.com:443/error?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557"
    },
    "environment":
    {
        "ipAddress": "192.0.2.0",
        "userAgent": "userAgent"
    },
    "loa": "high",
    "allowedProviders":
    [
        "bankid-cz"
    ],
    "language": "en",
    "flow": "redirect",
    "requestedAttributes":
    [
        "address",
        "bankidCzIdCard",
        "bankidCzLimitedLegalCapacity",
        "bankidCzPaymentAccounts",
        "bankidCzPep",
        "bankidCzTitlePrefix",
        "bankidCzTitleSuffix",
        "bankidCzUpdatedAt",
        "bankidCzVerificationProcess",
        "bankidCzVerificationTrustFramework",
        "countryOfBirth",
        "dateOfBirth",
        "18OrOlder",
        "email",
        "firstName",
        "gender",
        "lastName",
        "maritalStatus",
        "middleName",
        "name",
        "nationality",
        "nin",
        "phoneNumber",
        "placeOfBirth",
        "idpId"
    ],
    "sessionLifetime": 1200,
    "expiresAt": "2025-04-30T10:38:50.6756621+00:00"
}