User information

The Userinfo API provides you service to obtain claims about the authenticated End-User.

Notice This version of the service is not compliant with the OpenID Connect specification.

Get User info

Environment URI API Family
Production GET /commercial/csob/identity/v1/identify  KYC
Production GET /commercial/csob/identity/v1/userinfo IDC

 
This resource returns claims about the authenticated End-User (bank client) to which the user has given consent. The set of returned claims is given by contract between the third party application’s representative and bank’s representative.

Please note, in this version of the API the end user can not give consent to specific claims. There is only All-Or-Nothing" consent.

Request security requirements

Feature Required
Certificate
API key header
Access token header

Supported features

Feature Supported
Paging
Sorting
Filtering

Operation-specific errors

HTTP status code Error Description
401 invalid_scope The value of the scope in the certificate is invalid for the requested resource operation.
401 unauthorized Invalid token.
401 unauthorized Access token not valid to obtain historic data.

Please refer to the Overview section for the error response data structure and a list of errors common to all operations.

Sample request

HTTP

GET /commercial/csob/identity/v1/userinfo
HTTP/1.1
Host: api.csob.cz
APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b
Content-Type: application/json
Authorization: Bearer 3/TgBurw1ownSm9QUAZXjnZP584CD59OeFt2z0ksJWvNRrFZ2bwiH2rYr54rrlcEVv
Cache-Control: no-cache

cURL

curl -X GET https://api.csob.cz/commercial/csob/identity/v1/userinfo \
  -H 'APIKEY: l7xxca45406f0e934f7eb5df07d150a38e7b' \
  -H 'Authorization: Bearer 3/TgBurw1ownSm9QUAZXjnZP584CD59OeFt2z0ksJWvNRrFZ2bwiH2rYr54rrlcEVv' \
  -H 'Cache-Control: no-cache'

Response schema

{
  "$schema": "http://json-schema.org/draft-04/schema",
  "type": "object",
  "desciption": "Response schema for oAuth2.0 UserInfo resource", 
  "properties": {
    "given_name": {
      "description": "Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.",
      "type": "string"
    },
    "middle_name": {
      "description": "Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.",
      "type": "string"    
    },
    "family_name": {
      "description": "Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.",
      "type": "string"    
    },
    "csobid_title_after": {
      "description": "End-User's Title before.",
      "type": "string"    
    },
    "csobid_title_before": {
      "description": "End-User's Title after.",
      "type": "string"    
    },
    "csobid_address": {
      "description": "List of End-User's addresses",
      "type": "array",
      "items": {
        "type":"object",
        "properties": {
          "csobid_address_seq": {
            "description": "Address sequence number.",
            "type": "string"    
          },
          "csobid_address_address": {
            "description": "Full address, formatted for display or use on a mailing label. This field MAY contain multiple lines, separated by newlines. Newlines can be represented either as a carriage return/line feed pair (\r\n) or as a single line feed character (\n).",
            "type": "string"    
          },
          "csobid_address_type": {
            "description": "Address type.",
            "type": "string"    
          },
          "csobid_address_street": {
            "description": "Street name.",
            "type": "string"    
          },
          "csobid_address_postal_code": {
            "description": "Postal or ZIP code.",
            "type": "string"    
          },
          "csobid_address_city": {
            "description": "City or locality",
            "type": "string"    
          },
          "csobid_address_country": {
            "description": "Two-letter country codes as defined in ISO 3166.",
            "type": "string",
            "pattern": "^[A-Z]{2}$"
          },
          "csobid_address_house_number": {
            "description": "House number.",
            "type": "string"    
          }
        },
        "required": [
          "csobid_address_seq",
          "csobid_address_address",
          "csobid_address_type",
          "csobid_address_street",
          "csobid_address_postal_code",
          "csobid_address_city",
          "csobid_address_country",
          "csobid_address_house_number"
        ]
      }
    },
    "gender": {
      "description": "End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.",
      "type": "string"    
    },
    "birthdate": {
      "description": "End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.",
      "type": "string"    
    },
    "csobid_birth_number": {
      "description": "End-User's birth number.",
      "type": "string"    
    },
    "csobid_birth_place": {
      "description": "End-User's birth place.",
      "type": "string"    
    },
    "csobid_idcard": {
      "description": "List of End-User's ID cards",
      "type": "array",
      "items": {
        "type":"object",
        "properties": {
          "csobid_idcard_number": {
            "description": "ID card number.",
            "type": "string"    
          },
          "csobid_idcard_validfrom": {
            "description": "ID card validity date from, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.",
            "type": "string"    
          },
          "csobid_idcard_validto": {
            "description": "ID card validity date to, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.",
            "type": "string"    
          },
          "csobid_idcard_authority": {
            "description": "ID card authority.",
            "type": "string"    
          },
          "csobid_idcard_type": {
            "description": "ID card type.",
            "type": "string"    
          }
        },
        "required": [
          "csobid_idcard_number",
          "csobid_idcard_validfrom",
          "csobid_idcard_authority",
          "csobid_idcard_type"
        ]
      }
    },
    "csobid_nationality": {
      "description": "Two-letter End-User's nationality codes as defined in ISO 3166.",
      "type": "string",
      "pattern": "^[A-Z]{2}$"
    },
    "csobid_pep": {
      "description": "End-User's politically Exposed Person.",
      "type": "boolean"    
    },
    "email": {
      "description": "End-User's preferred e-mail address.",
      "type": "string"
    },
    "csobid_permanent_session_preference": {
      "description": "End-User's flag for request for permanent sign-in in the third party application.",
      "type": "boolean"    
    },
    "csobid_pseudonym_identifier": {
      "description": "End-User's unique identifier related to unique third party",
      "type": "string"  
    },
    "phone_number": {
      "description": "End-User's preferred telephone number.",
      "type": "string"
    },
    "csobid_bank_account": {
      "description": "End-User's bank account number.",
      "type": "string"    
    },
    "csobid_verification_level": {
      "description": "End-User's verification level in the bank.",
      "type": "string"    
    }
  },
  "required": [
    "csobid_pseudonym_identifier",
    "csobid_verification_level"
  ]
}

Response codes description

csobid_address_type codes
Address code Description
DOMICILE Domicile address
MAILING Mailing address
BILLING Billing address
csobid_idcard_type codes
ID Card code Description
IDENTITY Identity card
PASSPORT Passsport
gender codes
Gender code Description
M Male
F Female
U Unknown
csobid_pep codes
PEP code Description
Y The End-User(bank client) is politically Exposed Person.
N The End-User(bank client) is not politically Exposed Person.
csobid_verification_level codes
Verification level code Description
Y The End-User(bank client) was fully verified by the bank.
N The End-User(bank client) was partially verified by the bank.

Sample response

HTTP/1.1 200 OK
{
  "given_name": "Pán číslo jedna",
  "family_name": "ReuSecurity",
  "csobid_address": [
    {
      "csobid_address_address": "Slánská 697/5, 16300 Praha 6 - Řepy, Česká republika",
      "csobid_address_type": "MAILING",
      "csobid_address_street": "Slánská",
      "csobid_address_postal_code": "16300",
      "csobid_address_city": "Praha 6 - Řepy",
      "csobid_address_country": "CZ",
      "csobid_address_house_number": "697/5"
    },
    {
      "csobid_address_address": "Slánská 697/5, 16300 Praha 6 - Řepy, Česká republika",
      "csobid_address_type": "DOMICILE",
      "csobid_address_street": "Slánská",
      "csobid_address_postal_code": "16300",
      "csobid_address_city": "Praha 6 - Řepy",
      "csobid_address_country": "CZ",
      "csobid_address_house_number": "697/5"
    }
  ],
  "gender": "F",
  "birthdate": "1990-05-27",
  "csobid_birth_number": "9055277319",
  "csobid_birth_place": "Praha",
  "csobid_idcard": [
    {
      "csobid_idcard_number": "123456789",
      "csobid_idcard_validfrom": "2000-02-02",
      "csobid_idcard_validto": "2050-02-02",
      "csobid_idcard_authority": "Aa",
      "csobid_idcard_type": "IDENTITY"
    }
  ],
  "csobid_nationality": "CZ",
  "csobid_pep": "N",
  "email": "panjedna2x@mailinator.com",
  "csobid_pseudonym_identifier": "6605a9c1-e01d-4c43-9062-9148cb158e95",
  "phone_number": "+420774819407",
  "csobid_verification_level": "Y"
}