Download OpenAPI specification:Download
All endpoints related to customer identifications (KYC).
Validates whether the person specified in the request URL is eligible to complete a given identification method.
Successful result of the operation
Unexpected error
{- "method": "idnow"
}
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
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.
The content of the request.
Successful result of the operation
Unexpected error
{- "method": "idnow",
- "language": "EN",
- "proof_of_address_type": "GAS_BILL",
- "proof_of_address_issued_at": "2021-12-03"
}
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Returns all identifications for the person specified in the request URL.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications'
[- {
- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
]
Returns an array of document types that a customer may use to identify themselves along with a list of allowed issuing countries. The issuing_countries
are provided as ISO country codes (ISO-3166-1 alpha 2). If the customer does not provide a supported document type in the identification process, then their identification will eventually fail.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/supported_documents'
[- {
- "type": "Passport",
- "issuing_countries": [
- "ES"
]
}
]
Returns an array of document types as returned from Fourthline that a customer may use to identify themselves along with a list of allowed issuing countries. The issuingCountry
is provided as ISO country code (ISO-3166-1 alpha 2). If the customer does not provide a supported document type in the identification process, then their identification will eventually fail.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/supported_documents_from_fourthline'
[- {
- "issuingCountry": "ES",
- "idDocuments": [
- {
- "type": "Passport",
- "nationalities": [
- "ES"
]
}
]
}
]
This endpoint requests Solaris to begin the process for the person identification specified in the URL. The status of the identification will change to pending
. Once the identification process finishes, you will receive a notification from the IDENTIFICATION
webhook and the status will change to completed
or failed
depending on the outcome.
The operation was successful.
You are not authorized to perform this action.
Model not found.
There are more than 19 unsuccessful identification attempts for this customer.
Client error.
Internal server error.
{- "secret": "string"
}
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "terms_and_conditions_signed_at": "string"
}
Returns a completed person identification (i.e., the person identification process was successful). If you use the include_documents
filter, this method will also return the documents submitted by the customer during the identification process.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}?include_documents=true'
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Returns all identifications for all of your customers.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/identifications?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Breference%5D=string&filter%5Bid%5D=string&filter%5Bstatus%5D=string&filter%5Bperson_id%5D=string'
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Use this endpoint to send the SMS OTP from the customer to Swisscom to confirm the e-signing for a person identification via BankIdent. Call this endpoint when the person identification reaches the status confirmation_required
. Note: This method has been implemented in the IdentHub SDK; you do not need to implement it on your own.
The customer has successfully entered the SMS OTP. The QES process is complete.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X PATCH \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/confirm'
{- "id": "a7a57dadfcc83117b5c3b72f4113be25cidt",
- "reference": "null",
- "status": "confirmed",
- "completed_at": "null",
- "method": "bank",
- "iban": "DE11110101010100000020",
- "terms_and_conditions_signed_at": "2020-07-07T11:36:29.000Z",
- "authorization_expires_at": "2022-08-11T08:38:21.000Z",
- "confirmation_expires_at": "2022-08-11T08:37:23.000Z",
- "current_reference_token": "1234-5678"
}
Returns all bank identifications attempts for the person specified in the request URL.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/bank_identification_attempts'
[- {
- "id": "17a7389adaf83145770d8e6c00a398dfiatm",
- "person_id": "e2bbc86268e9a4667861b73f31dba03bcper",
- "identification_id": "efa83e0d8a9f33be3aeb5b5122d759adcidt",
- "successful": true,
- "failure_reason": "string",
- "iban": "DE11110101010100000020",
- "created_at": "2021-06-25T09:44:25.000Z"
}
]
Returns a list of IDnow attempts within a person identification. Each returned attempt includes the result, the reason (if the attempt was aborted), and the payload from the webhook related to that attempt.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/idnow_attempts'
{- "id": "e1eeb07262b695dc0ee5d4ab9350c12dcida",
- "result": "SUCCESS",
- "reason": null,
- "payload": {
- "identificationprocess": {
- "result": "SUCCESS",
- "companyid": "solarisbankvideoidenttesting",
- "filename": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip",
- "agentname": "TROBOT",
- "identificationtime": "2019-03-27T16:47:59+01:00",
- "id": "TST-EABTZ",
- "href": "/api/v1/solarisbankvideoidenttesting/identifications/b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip",
- "type": "WEB",
- "transactionnumber": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt"
}, - "customdata": {
- "custom1": null,
- "custom2": null,
- "custom3": null,
- "custom4": null,
- "custom5": null
}, - "contactdata": {
- "mobilephone": "+49301234567",
- "email": "person@example.com"
}, - "userdata": {
- "birthday": {
- "status": "MATCH",
- "value": "1972-12-24"
}, - "firstname": {
- "status": "MATCH",
- "value": "X-MANUALTEST-HAPPYPATH"
}, - "address": {
- "zipcode": {
- "status": "MATCH",
- "value": "10409"
}, - "country": {
- "status": "MATCH",
- "value": "DE"
}, - "city": {
- "status": "MATCH",
- "value": "BERLIN"
}, - "street": {
- "status": "NEW",
- "value": "STREET"
}
}, - "birthplace": {
- "status": "MATCH",
- "value": "BERLIN"
}, - "nationality": {
- "status": "NEW",
- "value": "DE"
}, - "birthname": {
- "status": "MATCH",
- "value": "DOE"
}, - "title": {
- "status": "NEW",
- "value": "TITLE"
}, - "lastname": {
- "status": "MATCH",
- "value": "MUSTERMANN"
}
}, - "identificationdocument": {
- "country": {
- "status": "NEW",
- "value": "DE"
}, - "number": {
- "status": "NEW",
- "value": "T01008921"
}, - "issuedby": {
- "status": "NEW",
- "value": "ISSUER"
}, - "dateissued": {
- "status": "NEW",
- "value": "2010-11-01"
}, - "type": {
- "status": "NEW",
- "value": "IDCARD"
}, - "validuntil": {
- "status": "NEW",
- "value": "2020-10-31"
}
}, - "attachments": {
- "pdf": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.pdf",
- "signature": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_signature.jpg",
- "xml": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.xml",
- "videolog": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.mp4",
- "idbackside": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idbackside.jpg",
- "idfrontside": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idfrontside.jpg",
- "security1": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security1.jpg",
- "userface": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_userface.jpg",
- "security2": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security2.jpg",
- "security_covered": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security_covered.jpg",
- "security3": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security3.jpg"
}
}
}
Returns information about the document that was used for legitimating an identification (e.g., passport, national ID).
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/legitimation_data'
{- "legitimation_document_number": "123456789",
- "legitimation_type": "PASSPORT",
- "legitimation_issuer": "Stadt Heidelberg",
- "legitimation_country": "GERMANY",
- "legitimation_issued_at": "2015-10-15",
- "legitimation_valid_until": "2025-10-14"
}
Update the legitimation data of an identification
the content of the request
Successful result of the operation
Unexpected error
{- "legitimation_document_number": "12345678910",
- "legitimation_type": "PASSPORT",
- "legitimation_issuer": "Stadt Heidelberg",
- "legitimation_country": "GERMANY",
- "legitimation_issued_at": "2010-01-01",
- "legitimation_valid_until": "2020-01-01"
}
{- "legitimation_document_number": "123456789",
- "legitimation_type": "PASSPORT",
- "legitimation_issuer": "Stadt Heidelberg",
- "legitimation_country": "GERMANY",
- "legitimation_issued_at": "2015-10-15",
- "legitimation_valid_until": "2025-10-14"
}
Uploads a .zip file to the person identification specified in the request URL (if the identification method requires it). The identification must have already been requested. This method is only relevant for identifications using Fourthline.
Successful result of the operation.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/zip' \ -H 'Content-Type: multipart/form-data' \ -F document=string
{- "iban": "DE92370601930002130041",
- "id": "d42a2dfcf32c4550bd1e1fe373bb953bsnap",
- "location": "string",
- "provider": "FIN_TEC_SYSTEMS",
- "status": "available",
- "status_description": "string",
- "wizard_session_key": "wiz04852083740"
}
Returns the PDF file generated from a PostIdent identification. The identification must have already been requested.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/pdf'
{- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "code": "build_pagination_headers_failure",
- "title": "Failed to build pagination headers.",
- "details": "Cannot connect to database."
}
This endpoint creates a new identification for the customer specified in the request URL and returns the identification_id
. Use this endpoint if the customer has lost access to their existing mobile phone number. After calling this endpoint, supply the returned identification_id
in the URL of the PATCH /persons/{person_id}/identifications/{identification_id}/request
method.
Successful result of the operation.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/for_mobile_change'
{- "identification_id": "string"
}
This endpoint sets the status
of an identification to successful
. Use this endpoint if you are implementing the manual KYC flow in your solution.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
{- "completed_at": "2019-08-24T14:15:22Z"
}
{- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "code": "build_pagination_headers_failure",
- "title": "Failed to build pagination headers.",
- "details": "Cannot connect to database."
}
This endpoint requests an identification for the person specified in the URL. You can pass a custom value to the testing robot using the parameter custom5
.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
{- "custom5": "X-AUTOTEST-HAPPYPATH"
}
{- "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
- "status": "400",
- "code": "build_pagination_headers_failure",
- "title": "Failed to build pagination headers.",
- "details": "Cannot connect to database."
}
Returns an account snapshot that was added to a person identification.
AccountSnapshot
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/account_snapshot'
{- "iban": "DE92370601930002130041",
- "id": "d42a2dfcf32c4550bd1e1fe373bb953bsnap",
- "location": "string",
- "provider": "FIN_TEC_SYSTEMS",
- "status": "available",
- "status_description": "string",
- "wizard_session_key": "wiz04852083740"
}
Testing endpoint that updates the status of a Fourthline identification. See the Fourthline guide for a full list of test values.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
{- "provider_status_code": "10"
}
{- "result": "Identification {id} successfully started"
}
-> "Creates an identification session for the person specified in the request URL based on the identification method(s) supplied in the request. Note that if the customer is not eligible for one of the identification methods, then this endpoint will return an error. Use the eligibility checking endpoint to verify this beforehand:" + GET /v1/persons/{person_id}/identification_eligibility_checks
The content of the request.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
{- "callback_url": "someurl.com",
- "identification_methods": [
- "idnow"
]
}
{- "id": "acdede097f821bd8037465d691f69506ises",
- "identification_methods": [
- "idnow"
], - "status": "created"
}
Returns a specific identification session for the person specified in the request URL.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identification_sessions/{identification_session_id}'
{- "id": "acdede097f821bd8037465d691f69506ises",
- "identification_methods": [
- "idnow"
], - "status": "created"
}
Returns the configuration data for a specific person identification session.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identification_sessions/{identification_session_id}/configuration'
{- "terms_and_conditions_pre_accepted": true,
- "fourthline_provider": "fourthline"
}
Creates a person identification within an existing person identification session.
The content of the request.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
{- "method": "idnow",
- "language": "EN",
- "proof_of_address_type": "GAS_BILL",
- "proof_of_address_issued_at": "2021-12-03"
}
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Returns the details of a person's identification. In the request URL, you must specify the identification session within which the identification was created.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identification_sessions/{identification_session_id}/identifications/{id}?include_documents=true'
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Simulates the bank identification process for the given person until the identification reaches the status identification_data_required
.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identification_sessions/{identification_session_id}/simulate_bank_id_until_identification_data_required'
{- "id": "9dfe2f4edaa67138be0c0c1cd3a7d849cidt",
- "reference": "TST-ELCCJ",
- "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.",
- "line_2": "45",
- "postal_code": "14169",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "documents": [
- {
- "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_reason": "ALREADY_IDENTIFIED_SUCCESSFULLY",
- "iban": "DE11010101010101010100",
- "authorization_expires_at": "string",
- "confirmation_expires_at": "string",
- "provider_status_code": 1000
}
Returns all of the IDnow signature packages for the person specified in the request URL.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/signings'
[- {
- "id": "7da925f612600ee0a2c386afe1cac4bccsig",
- "reference": "TST-QMNBB",
- "state": "successful",
- "status": "finished",
- "completed_at": "2020-04-08T12:53:42.000Z",
- "method": "idnow",
- "identification_id": "155b0818593319dd718e2ec139718973cidt",
- "documents": [
- {
- "id": "99167f972843c1bd4db0b55719e70df9cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_ldoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:56.000Z"
}, - {
- "id": "d3e6e5552009db11ca0b004836d53512cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_cdoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "5d4cbca60126f0e25503b0332f10ead8cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml",
- "content_type": "application/xml",
- "document_type": "OTHER",
- "size": 2894,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "03bfa749ce3b9e6ad41f398c32d7c1eecdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml.sig",
- "content_type": "application/pgp-signature",
- "document_type": "SIGNATURE",
- "size": 256,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:58.000Z"
}
]
}
]
Uploads documents that are required for the e-signature process in an IDnow identification. You must specify the position of the signature in the document and the type of document in the request. The options for document type are cdoc
(for contracts) and ldoc
(for SDD mandates).
The content of the request
Successful result of the operation
Unexpected error
{- "method": "idnow",
- "language": "EN",
- "documents": [
- {
- "data": {
- "type": "base64",
- "value": ""
}, - "identifier": "cdoc",
- "definition": {
- "signatures": {
- "mysignature1": {
- "position": {
- "page": "1",
- "left": 50,
- "width": 50,
- "bottom": 50,
- "height": 50
}
}
}
}
}
]
}
{- "id": "7da925f612600ee0a2c386afe1cac4bccsig",
- "reference": "TST-QMNBB",
- "state": "successful",
- "status": "finished",
- "completed_at": "2020-04-08T12:53:42.000Z",
- "method": "idnow",
- "identification_id": "155b0818593319dd718e2ec139718973cidt",
- "documents": [
- {
- "id": "99167f972843c1bd4db0b55719e70df9cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_ldoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:56.000Z"
}, - {
- "id": "d3e6e5552009db11ca0b004836d53512cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_cdoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "5d4cbca60126f0e25503b0332f10ead8cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml",
- "content_type": "application/xml",
- "document_type": "OTHER",
- "size": 2894,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "03bfa749ce3b9e6ad41f398c32d7c1eecdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml.sig",
- "content_type": "application/pgp-signature",
- "document_type": "SIGNATURE",
- "size": 256,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:58.000Z"
}
]
}
Returns a list of IDnow attempts within a person signing. Each returned attempt includes the result, the reason (if the attempt was aborted), and the payload from the webhook related to that attempt.
Successful result of the operation
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/signings/{signing_id}/idnow_attempts'
{- "id": "e1eeb07262b695dc0ee5d4ab9350c12dcida",
- "result": "SUCCESS",
- "reason": null,
- "payload": {
- "identificationprocess": {
- "result": "SUCCESS",
- "companyid": "solarisbankvideoidenttesting",
- "filename": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip",
- "agentname": "TROBOT",
- "identificationtime": "2019-03-27T16:47:59+01:00",
- "id": "TST-EABTZ",
- "href": "/api/v1/solarisbankvideoidenttesting/identifications/b2d949eb12ecd6798fa8e2ae66fc4a5acidt.zip",
- "type": "WEB",
- "transactionnumber": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt"
}, - "customdata": {
- "custom1": null,
- "custom2": null,
- "custom3": null,
- "custom4": null,
- "custom5": null
}, - "contactdata": {
- "mobilephone": "+49301234567",
- "email": "person@example.com"
}, - "userdata": {
- "birthday": {
- "status": "MATCH",
- "value": "1972-12-24"
}, - "firstname": {
- "status": "MATCH",
- "value": "X-MANUALTEST-HAPPYPATH"
}, - "address": {
- "zipcode": {
- "status": "MATCH",
- "value": "10409"
}, - "country": {
- "status": "MATCH",
- "value": "DE"
}, - "city": {
- "status": "MATCH",
- "value": "BERLIN"
}, - "street": {
- "status": "NEW",
- "value": "STREET"
}
}, - "birthplace": {
- "status": "MATCH",
- "value": "BERLIN"
}, - "nationality": {
- "status": "NEW",
- "value": "DE"
}, - "birthname": {
- "status": "MATCH",
- "value": "DOE"
}, - "title": {
- "status": "NEW",
- "value": "TITLE"
}, - "lastname": {
- "status": "MATCH",
- "value": "MUSTERMANN"
}
}, - "identificationdocument": {
- "country": {
- "status": "NEW",
- "value": "DE"
}, - "number": {
- "status": "NEW",
- "value": "T01008921"
}, - "issuedby": {
- "status": "NEW",
- "value": "ISSUER"
}, - "dateissued": {
- "status": "NEW",
- "value": "2010-11-01"
}, - "type": {
- "status": "NEW",
- "value": "IDCARD"
}, - "validuntil": {
- "status": "NEW",
- "value": "2020-10-31"
}
}, - "attachments": {
- "pdf": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.pdf",
- "signature": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_signature.jpg",
- "xml": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.xml",
- "videolog": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt.mp4",
- "idbackside": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idbackside.jpg",
- "idfrontside": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_idfrontside.jpg",
- "security1": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security1.jpg",
- "userface": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_userface.jpg",
- "security2": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security2.jpg",
- "security_covered": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security_covered.jpg",
- "security3": "b2d949eb12ecd6798fa8e2ae66fc4a5acidt_security3.jpg"
}
}
}
Returns an IDnow e-signature package. Use this endpoint to check the status of a signing. The response includes an array of documents
that the customer signed. The document_type
property of signed contracts will contain the value SIGNED_CONTRACT
.
Successful result of the operation.
An error occurred on the client side.
You are not authorized to perform this action.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/signings/{signing_id}'
{- "id": "7da925f612600ee0a2c386afe1cac4bccsig",
- "reference": "TST-QMNBB",
- "state": "successful",
- "status": "finished",
- "completed_at": "2020-04-08T12:53:42.000Z",
- "method": "idnow",
- "identification_id": "155b0818593319dd718e2ec139718973cidt",
- "documents": [
- {
- "id": "99167f972843c1bd4db0b55719e70df9cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_ldoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:56.000Z"
}, - {
- "id": "d3e6e5552009db11ca0b004836d53512cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt_cdoc_signed.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 210012,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "5d4cbca60126f0e25503b0332f10ead8cdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml",
- "content_type": "application/xml",
- "document_type": "OTHER",
- "size": 2894,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:57.000Z"
}, - {
- "id": "03bfa749ce3b9e6ad41f398c32d7c1eecdoc",
- "name": "155b0818593319dd718e2ec139718973cidt.xml.sig",
- "content_type": "application/pgp-signature",
- "document_type": "SIGNATURE",
- "size": 256,
- "customer_accessible": false,
- "created_at": "2020-04-08T12:53:58.000Z"
}
]
}
This endpoint runs through a test of the signing process using a robot. Please refer to the identification of a person with first name or last name using X-AUTOTEST-your_robot_name
.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/idnow/sign_with_robot?identification_id=string'
This endpoint runs through a test of the person identification process using a robot. Please refer to the identification of a person with first name or last name using X-AUTOTEST-your_robot_name
.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/idnow/identify_with_robot?id=string'
Creates the business identification resource (BKYC) for a business, which automatically triggers both the legal identification of the business (handled by Solaris) and the video identification of all applicable natural person(s), such as legal representative(s).
the content of the request
Successful result of the operation
Invalid request
Forbidden
Generic Error
{- "method": "idnow"
}
{- "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
- "method": "idnow",
- "reference": "TST-VWKRA",
- "status": "pending",
- "completed_at": "2021-20-03T18:01:48.000Z",
- "legal_representatives": [
- "string"
], - "legal_identification_status": "information_required",
- "legal_identification_reason": "string",
- "legal_identification_missing_information": "COMPLIANCE_QUESTIONS",
- "legal_identification_missing_information_details": "string",
- "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}
Retrieves all identifications for a business. You can filter the results by page number, page size, identification status, legal identification status, etc.
Successful result of the operation
Invalid request
Forbidden
Generic Error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/{business_id}/identifications'
{- "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
- "method": "idnow",
- "reference": "TST-VWKRA",
- "status": "pending",
- "completed_at": "2021-20-03T18:01:48.000Z",
- "legal_representatives": [
- "string"
], - "legal_identification_status": "information_required",
- "legal_identification_reason": "string",
- "legal_identification_missing_information": "COMPLIANCE_QUESTIONS",
- "legal_identification_missing_information_details": "string",
- "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}
Creates an additional final verification step to allow partners to approve or reject the business identification based on their internal compliance assessments. This is an optional endpoint for partners with this specific use case.
the content of the request
Successful result of the operation
Invalid request
Forbidden
Generic Error
{- "approved": true
}
{- "business_identification_id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
- "approved": true
}
Retrieves the details of a single business identification, including the status of the overall business identification process, video identification status and the URLs for the business's legal_representatives, and the legal identification status. You can use this endpoint to check status updates or any changes to the fields.
Successful result of the operation
Invalid request
Forbidden
Generic Error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/{business_id}/identifications/{business_identification_id}'
{- "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
- "method": "idnow",
- "reference": "TST-VWKRA",
- "status": "pending",
- "completed_at": "2021-20-03T18:01:48.000Z",
- "legal_representatives": [
- "string"
], - "legal_identification_status": "information_required",
- "legal_identification_reason": "string",
- "legal_identification_missing_information": "COMPLIANCE_QUESTIONS",
- "legal_identification_missing_information_details": "string",
- "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}
Returns all business identifications for all of your customers. You can add filters to your query to filter results.
Successful result of the operation
Invalid request
Forbidden
Generic Error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/businesses/identifications?page%5Bnumber%5D=string&page%5Bsize%5D=string&filter%5Bprovider%5D=string&filter%5Breference%5D=string&filter%5Bstatus%5D=string&filter%5Bcompleted_at%5D=string&filter%5Bcreated_at%5D=string&filter%5Bupdated_at%5D=string&filter%5Blegal_identification_status%5D=string'
{- "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
- "method": "idnow",
- "reference": "TST-VWKRA",
- "status": "pending",
- "completed_at": "2021-20-03T18:01:48.000Z",
- "legal_representatives": [
- "string"
], - "legal_identification_status": "information_required",
- "legal_identification_reason": "string",
- "legal_identification_missing_information": "COMPLIANCE_QUESTIONS",
- "legal_identification_missing_information_details": "string",
- "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}
Returns all the compliance questions raised by Solaris in relation to a business legal identification. The API response returns the compliance questions' IDs and texts. Each question has its own unique ID. You have to redirect these questions to your customers and collect their answers and submit them to Solaris.