Skip to content
/Person identifications

Customer Identification (KYC) (1.0)

All endpoints related to customer identifications (KYC).

Download OpenAPI description
identifications.json
identifications.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/identity/identifications/

Person identifications

Operations

(Bankident only) Check identification eligibility

Request

Validates whether the person specified in the request URL is eligible to complete a given identification method.

Path
person_idstringrequired

The unique ID of the person resource created for a customer.

Example: dc1a6812a14f6cc338cd084208535bcdcper
Bodyapplication/json

the content of the request

methodstring

The identification method to check for eligibility for the given person. Currently only works for Bankident.

Value"bank"
Example: "bank"
application/json
{
  "method": "bank"
}

Responses

Successful result of the operation

Bodyapplication/json
methodstring

Identification method to check for eligibility. Currently, only Bankident (bank) is supported.

Example: "bank"
eligibleboolean

Indicates whether the customer is eligible for the identification method.

Example: true
reasonsArray of arrays

Array of reasons why the customer is not eligible for the identification method.

Example: ["match_for_person_data_not_found"]
Response
application/json
{
  "method": "bank",
  "eligible": true,
  "reasons": [
    "match_for_person_data_not_found"
  ]
}

Create an identification

Request

Creates an identification for the person specified in the request URL. Note that this endpoint does not send a request to the identification provider to start the identification process.

Path
person_idstringrequired

The unique ID of the person resource created for a customer.

Example: dc1a6812a14f6cc338cd084208535bcdcper
Bodyapplication/json

The content of the request.

methodstring

The identification method to use for the person identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""idnow_custom""manual""postident"
Example: "idnow"
languagestring

(IDnow only) The customer's preferred language for the identification process.

Enum"DE""EN"
Example: "EN"
referencestring

A reference supplied by the identification provider.

proof_of_address_typestring

The type of document submitted by the customer as a proof of address. This field is mandatory if the customer's identification document does not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
Example: "GAS_BILL"
proof_of_address_issued_atstring(date)

The date when the proof of address document was issued. This field is mandatory if the customer's identification document does not include their address.

Example: "2021-12-03"
ibanstring

The customer's IBAN. This field is mandatory if the identification method is bank or bank_id. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

device_datastring

Encoded device fingerprint generated using the Seon SDK. See the device monitoring guide for more information about generating this value.

Example: "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/"
product_namestring

The product name for which you want to open an account. Check the account opening guide for more information about this field.

Enum"CURRENT_ACCOUNT_BUSINESS_FRANCE""CURRENT_ACCOUNT_BUSINESS_GERMANY""CURRENT_ACCOUNT_BUSINESS_ITALY""CURRENT_ACCOUNT_BUSINESS_SPAIN""CURRENT_ACCOUNT_CONSUMER_FRANCE""CURRENT_ACCOUNT_CONSUMER_GERMANY""CURRENT_ACCOUNT_CONSUMER_ITALY""CURRENT_ACCOUNT_CONSUMER_SPAIN""CURRENT_ACCOUNT_FREELANCER_FRANCE""CURRENT_ACCOUNT_FREELANCER_GERMANY"
Example: "CURRENT_ACCOUNT_CONSUMER_GERMANY"
account_typestring

The type of account you want to open. Must correspond to the product_name and customer_type. Check the account opening guide for more information about this field.

Enum"CALL_MONEY""CARD_SETTLEMENT_PARTNER""CHECKING_BUSINESS""CHECKING_PERSONAL""CHECKING_PERSONAL_OVERDRAFT""CHECKING_SOLE_PROPRIETOR""CHECKING_SUBACCOUNT""CUSTOMER_CURRENCY_ACCOUNT""DECOUPLED_CARD_BUSINESS""DECOUPLED_CARD_PERSONAL"
Example: "CHECKING_PERSONAL"
account_purposestring

(bank_plus only) The purpose of the account. Use primary unless otherwise instructed.

Example: "primary"
account_bicstring

(bank_plus only) The BIC to apply to the account. Choose the BIC that corresponds with the branch in which you want to open the account.

Example: "SOBKDEB2XXX"
account_currencystring

(bank_plus only) The currency of the account.

Enum"CAD""CHF""CNY""DKK""EUR""GBP""HKD""JPY""NOK""SEK"
Example: "EUR"
application/json
{
  "method": "idnow",
  "language": "EN",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "device_data": "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
referencestring

Reference generated by the identification provider.

Example: "TST-ELCCJ"
urlstring

(IDnow only) Redirect URL used to start the identification process.

Example: "https://go.test.idnow.de/company_id/identifications/identification_id"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "successful"
completed_atstring

Date and time when the identification was completed.

Example: "2021-09-14T18:18:28.000Z"
methodstring

The method used for the identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""idnow_custom""manual""postident"
Example: "idnow"
proof_of_address_typestring

The type of document submitted by the customer as a proof of address if their identification document did not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
Example: "GAS_BILL"
proof_of_address_issued_atstring

The date when the proof of address document was issued.

Example: "2021-12-03"
languagestring

(IDnow only) The customer's preferred language for the identification process.

Enum"DE""EN"
Example: "EN"
person_idstring

ID of the person for whom the identification was initiated.

Example: "992de312a545bb24a88ddbf57ae8b1ffcper"
addressobject

The customer's address.

documentsArray of objects

Documents provided by the customer during the identification process.

Example: [{"id":"448b75fa1c57eecda41d91c66c22faa6cdoc","name":"file1.pdf","content_type":"application/json","document_type":"KYC_REPORT","size":803580},{"id":"94eb22a9311be9a1fbb698c448b0b337cdoc","name":"file2.jpg","content_type":"image/jpeg","document_type":"SIGNATURE","size":25349}]
failure_reasonstring or null

Additional context around why the identification failed. Value depends on the identification method.

ibanstring

Optional IBAN provided for bank and bank_id identifications. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

Example: "DE11010101010101010100"
authorization_expires_atstring or null

The date and time by which the authorization for the end customer must be requested.

confirmation_expires_atstring or null

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

provider_status_codeinteger or null

(Fourthline only) Status code returned by the identification provider.

Enum1000100110021003100410051006100710081009
account_verification_errorstring or null

Session Error returned by Tink in the account verification process. Will only be populated when failure_reason is account_snaphot_failed or account_snapshot_expired. Only present for identifications within identification session.

Enum"accounts_failed""client_aborted""init_failed""login_failed""login_next_failed""max_login_tries""max_tan_tries""no_compatible_accounts""pinned_iban_not_found""security_setting_rejection"
idnow_process_typestring

When method idnow is selected, the process type will reflect which idnow process was chosen.

Example: "eid"
Response
application/json
{
  "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
  "reference": "TST-ELCCJ",
  "url": "https://go.test.idnow.de/company_id/identifications/identification_id",
  "status": "successful",
  "completed_at": "2021-09-14T18:18:28.000Z",
  "method": "idnow",
  "proof_of_address_type": "GAS_BILL",
  "proof_of_address_issued_at": "2021-12-03",
  "language": "EN",
  "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
  "address": {
    "line_1": "BERLINER STR. 45",
    "line_2": "Erste Etage",
    "postal_code": "14169",
    "city": "Berlin",
    "country": "DE",
    "state": "BE"
  },
  "documents": [
    { … },
    { … }
  ],
  "failure_reason": "string",
  "iban": "DE11010101010101010100",
  "authorization_expires_at": "string",
  "confirmation_expires_at": "string",
  "provider_status_code": 1000,
  "account_verification_error": "accounts_failed",
  "idnow_process_type": "eid"
}

Index identifications for a person

Request

Returns all identifications for the person specified in the request URL.

Path
person_idstringrequired

The unique ID of the person resource created for a customer.

Example: dc1a6812a14f6cc338cd084208535bcdcper
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the person identification.

Example: "9dfe2f4edaa67138be0c0c1cd3a7d849cidt"
referencestring

Reference generated by the identification provider.

Example: "TST-ELCCJ"
urlstring

(IDnow only) Redirect URL used to start the identification process.

Example: "https://go.test.idnow.de/company_id/identifications/identification_id"
statusstring

The current status of the identification. Note The status value depends on the identification method, check the KYC guides for more information.

Enum"aborted""authorization_required""confirmation_required""confirmed""created""canceled""expired""failed""identification_data_required""pending"
Example: "successful"
completed_atstring

Date and time when the identification was completed.

Example: "2021-09-14T18:18:28.000Z"
methodstring

The method used for the identification.

Enum"bank""bank_id""bank_plus""fourthline""idnow""idnow_autoident""idnow_custom""manual""postident"
Example: "idnow"
proof_of_address_typestring

The type of document submitted by the customer as a proof of address if their identification document did not include their address.

Enum"BANK_ACCOUNT_STATEMENT""CERTIFICATE_OF_REGISTRATION""ELECTRICITY_BILL""GAS_BILL""HEATING_BILL""INTERNET_BILL""TELEPHONE_BILL""WATER_BILL"
Example: "GAS_BILL"
proof_of_address_issued_atstring

The date when the proof of address document was issued.

Example: "2021-12-03"
languagestring

(IDnow only) The customer's preferred language for the identification process.

Enum"DE""EN"
Example: "EN"
person_idstring

ID of the person for whom the identification was initiated.

Example: "992de312a545bb24a88ddbf57ae8b1ffcper"
addressobject

The customer's address.

documentsArray of objects

Documents provided by the customer during the identification process.

Example: [{"id":"448b75fa1c57eecda41d91c66c22faa6cdoc","name":"file1.pdf","content_type":"application/json","document_type":"KYC_REPORT","size":803580},{"id":"94eb22a9311be9a1fbb698c448b0b337cdoc","name":"file2.jpg","content_type":"image/jpeg","document_type":"SIGNATURE","size":25349}]
failure_reasonstring or null

Additional context around why the identification failed. Value depends on the identification method.

ibanstring

Optional IBAN provided for bank and bank_id identifications. Please note that Solaris only accepts certain banks for the Bankident KYC flow. See the full list here.

Example: "DE11010101010101010100"
authorization_expires_atstring or null

The date and time by which the authorization for the end customer must be requested.

confirmation_expires_atstring or null

The date and time by which the customer must input the OTP sent to their mobile number for the QES process.

provider_status_codeinteger or null

(Fourthline only) Status code returned by the identification provider.

Enum1000100110021003100410051006100710081009
account_verification_errorstring or null

Session Error returned by Tink in the account verification process. Will only be populated when failure_reason is account_snaphot_failed or account_snapshot_expired. Only present for identifications within identification session.

Enum"accounts_failed""client_aborted""init_failed""login_failed""login_next_failed""max_login_tries""max_tan_tries""no_compatible_accounts""pinned_iban_not_found""security_setting_rejection"
idnow_process_typestring

When method idnow is selected, the process type will reflect which idnow process was chosen.

Example: "eid"
]
Response
application/json
[
  {
    "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
    "reference": "TST-ELCCJ",
    "url": "https://go.test.idnow.de/company_id/identifications/identification_id",
    "status": "successful",
    "completed_at": "2021-09-14T18:18:28.000Z",
    "method": "idnow",
    "proof_of_address_type": "GAS_BILL",
    "proof_of_address_issued_at": "2021-12-03",
    "language": "EN",
    "person_id": "992de312a545bb24a88ddbf57ae8b1ffcper",
    "address": { … },
    "documents": [ … ],
    "failure_reason": "string",
    "iban": "DE11010101010101010100",
    "authorization_expires_at": "string",
    "confirmation_expires_at": "string",
    "provider_status_code": 1000,
    "account_verification_error": "accounts_failed",
    "idnow_process_type": "eid"
  }
]

Device Monitoring

Operations

Identification sessions

Operations

Person signings

Operations

IDnow

Operations

Business identifications

Operations

Business screener hits

Operations