Download OpenAPI specification:Download
Creates a person resource for a new customer.
The mandatory data points you must provide when creating a person vary based on the country where you are opening the account. See the required data points guide for information about which data points are required for each country.
Important: Please collect the customer's tax residence country separately. Do not default to their residence country for their tax country.
The content of the request.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24T00:00:00.000Z",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "birth_province": "BE",
- "birth_post_code": "10233",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "main_income_source": "PUBLIC_SUBSIDIES",
- "purpose_of_account_opening": "DAILY_EXPENSES",
- "socioprofessional_category": "EMPLOYEES",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "registration_number": "1234567890"
}
{- "id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "flagged_by_compliance": false,
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "screening_progress": "SCREENED_ACCEPTED",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "aml_follow_up_date": "2017-01-15",
- "aml_confirmed_on": "2017-01-30",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "international_operativity_expectation": [
- "NORTH_AMERICA"
], - "risk_classification_status": "NORMAL_RISK",
- "customer_vetting_status": "NO_MATCH",
- "registration_number": "1234567890",
- "legitimation_valid_until": "2025-12-31"
}
Returns an array containing all the persons you have created.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons?page%5Bnumber%5D=string&page%5Bsize%5D=string&sort=string&filter%5Bfirst_name%5D=string&filter%5Blast_name%5D=string&filter%5Bbirth_date%5D=string&filter%5Bbirth_date%5D%5Bmin%5D=string&filter%5Bbirth_date%5D%5Bmax%5D=string'
[- {
- "id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "flagged_by_compliance": false,
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "screening_progress": "SCREENED_ACCEPTED",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "aml_follow_up_date": "2017-01-15",
- "aml_confirmed_on": "2017-01-30",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "international_operativity_expectation": [
- "NORTH_AMERICA"
], - "risk_classification_status": "NORMAL_RISK",
- "customer_vetting_status": "NO_MATCH",
- "registration_number": "1234567890",
- "legitimation_valid_until": "2025-12-31"
}
]
Returns the person resource specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{id}'
{- "id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "flagged_by_compliance": false,
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "screening_progress": "SCREENED_ACCEPTED",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "aml_follow_up_date": "2017-01-15",
- "aml_confirmed_on": "2017-01-30",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "international_operativity_expectation": [
- "NORTH_AMERICA"
], - "risk_classification_status": "NORMAL_RISK",
- "customer_vetting_status": "NO_MATCH",
- "registration_number": "1234567890",
- "legitimation_valid_until": "2025-12-31"
}
Updates one or more properties on a person resource. Note that this will trigger the change request process (unless the property being updated has a value of null
).
The content of the request.
Successful result of the operation
The request was accepted, and now the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24T00:00:00.000Z",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "birth_province": "BE",
- "birth_post_code": "10233",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "main_income_source": "PUBLIC_SUBSIDIES",
- "purpose_of_account_opening": "DAILY_EXPENSES",
- "socioprofessional_category": "EMPLOYEES",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "registration_number": "1234567890"
}
{- "id": "dc1a6812a14f6cc338cd084208535bcdcper",
- "salutation": "MR",
- "title": "DR",
- "first_name": "Peter",
- "last_name": "Mustermann",
- "address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "contact_address": {
- "line_1": "Musterstrasse",
- "line_2": "Musterstrasse",
- "postal_code": "10409",
- "city": "Berlin",
- "country": "DE",
- "state": "BE"
}, - "email": "person@example.com",
- "mobile_number": "49301234567",
- "birth_name": "Doe",
- "birth_date": "1972-12-24",
- "birth_city": "Berlin",
- "birth_country": "DE",
- "nationality": "DE",
- "employment_status": "FREELANCER",
- "job_title": "Head of everything",
- "tax_information": {
- "tax_assessment": "SEPARATE",
- "marital_status": "MARRIED"
}, - "fatca_relevant": true,
- "fatca_crs_confirmed_at": "2017-01-01T00:00:00.000Z",
- "business_purpose": "helping people to find themselves",
- "industry": "OTHER_SERVICES",
- "industry_key": "EDUCATION",
- "terms_conditions_signed_at": "2017-01-01T00:00:00.000Z",
- "own_economic_interest_signed_at": "2017-01-01T00:00:00.000Z",
- "flagged_by_compliance": false,
- "expected_monthly_revenue_cents": 20000,
- "vat_number": "DE999999999",
- "business_trading_name": "My Business",
- "nace_code": "I 56.30",
- "business_address_line_1": "StreetStrasse, 42",
- "business_address_line_2": "4th floor",
- "business_postal_code": "12345",
- "business_city": "Berlin",
- "business_country": "DE",
- "screening_progress": "SCREENED_ACCEPTED",
- "data_terms_signed_at": "2017-01-01T00:00:00.000Z",
- "aml_follow_up_date": "2017-01-15",
- "aml_confirmed_on": "2017-01-30",
- "annual_income_range": "RANGE_1",
- "branch": "DE",
- "work_country": "DE",
- "work_province": "",
- "self_declared_as_pep": false,
- "international_operativity_expectation": [
- "NORTH_AMERICA"
], - "risk_classification_status": "NORMAL_RISK",
- "customer_vetting_status": "NO_MATCH",
- "registration_number": "1234567890",
- "legitimation_valid_until": "2025-12-31"
}
Registers a new mobile number for a person. Please note the following:
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "number": "+49301234567"
}
{- "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
- "number": "+49301234567",
- "verified": false
}
Returns information about a person's registered mobile number. Returns a 404
error if no mobile number has been registered.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/mobile_number'
{- "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
- "number": "+49301234567",
- "verified": false
}
Removes a customer's registered mobile number.
If the request is successful and the mobile number has already been confirmed, then the API will trigger the change request process. The person who owns the mobile number will receive an SMS informing them that the number was deleted.
If the request is successful but the mobile number has not been verified, then the mobile number will be deleted without a change request.
The request was successful (if the mobile number was not verified).
The request is accepted, and the customer must confirm the change request.
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "number": "+4930123123123"
}
{- "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
- "number": "+49301234567",
- "verified": false
}
Submits the SMS OTP that the customer received on their mobile number to confirm it and authorize it for use with 2FA. The API will respond with a 403
error if the token has expired or if an invalid token is provided.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "number": "+49301234567",
- "token": "666042"
}
{- "id": "303fd0bd4ad5f0f0e999ed0d9539792fcmno",
- "number": "+49301234567",
- "verified": false
}
Submits a tax identification for a person.
The first tax identification to be submitted for a person must be their primary tax identification. If you add another tax identification with the value of primary
set to true
, then the previous primary tax identification will become a secondary tax identification (i.e., its primary
value will change to false
).
You may only create one tax identification per country per customer.
Important: When creating a tax identification for a person, always collect the country
value from the person separately from their residence country in your frontend. Do not default to the customer's physical residence (i.e., the country
value of their person
resource).
The content of the request.
number | string Tax Identification Number (TIN). Must be left empty if |
country | string The country that issued the customer's TIN. Use an ISO 3661 two-character code. |
primary | boolean Indicates whether the provided TIN is the customer's primary TIN (i.e., their primary tax residence). |
reason_no_tin | string Specifies the reason why the customer has not yet provided their TIN. |
reason_description | string Additional clarification around why the customer has not yet provided their TIN. |
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "number": "31659837651",
- "country": "DE",
- "primary": true
}
{- "id": "cba4289c773b7450482ee88a6e5126e9ctin",
- "country": "AD",
- "number": "12345678901",
- "primary": true,
- "reason_no_tin": "NOT_ASSIGNED_YET",
- "reason_description": "string",
- "valid_until": "2019-08-24",
- "tax_id_type": "NIE"
}
Returns an array containing all of the given person's tax identifications.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/tax_identifications'
[- {
- "id": "cba4289c773b7450482ee88a6e5126e9ctin",
- "country": "AD",
- "number": "12345678901",
- "primary": true,
- "reason_no_tin": "NOT_ASSIGNED_YET",
- "reason_description": "string",
- "valid_until": "2019-08-24",
- "tax_id_type": "NIE"
}
]
Returns the person tax identification specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/tax_identifications/{id}'
{- "id": "cba4289c773b7450482ee88a6e5126e9ctin",
- "country": "AD",
- "number": "12345678901",
- "primary": true,
- "reason_no_tin": "NOT_ASSIGNED_YET",
- "reason_description": "string",
- "valid_until": "2019-08-24",
- "tax_id_type": "NIE"
}
Modifies one or more properties of a person's tax identification.
The content of the request.
number | string The person's tax identification number (TIN). |
country | string The country that issued the customer's TIN. Use an ISO 3661 two-character code. |
primary | boolean Specifies whether this is the customer's primary TIN. |
reason_no_tin | string Specifies the reason why the customer has not yet provided their TIN. |
reason_description | string Additional clarification around why the customer has not yet provided their TIN. |
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "number": "31659837651",
- "country": "DE",
- "primary": true
}
{- "id": "cba4289c773b7450482ee88a6e5126e9ctin",
- "country": "AD",
- "number": "12345678901",
- "primary": true,
- "reason_no_tin": "NOT_ASSIGNED_YET",
- "reason_description": "string",
- "valid_until": "2019-08-24",
- "tax_id_type": "NIE"
}
Uploads a document and links it to the person specified in the request URL.
Unlike most other endpoints, this request uses the content-type
of multipart/form-data
. You must submit the parameters as form-data
items instead of a raw JSON body.
By default, uploaded documents are not accessible to customers (i.e., the customer_accessible
value is set to false
).
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents' \ -H 'Content-Type: multipart/form-data' \ -F file=string \ -F document_type=ACCOUNT_SNAPSHOT.FINTECSYSTEMS
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Returns an array containing all documents linked to the person specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents?page%5Bnumber%5D=string&page%5Bsize%5D=string&customer_accessible=true&include_deleted=true&sort=created_at'
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Returns the binary file related to the document specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}/file'
{- "date": "Sun, 13 Aug 2017 20:35:45 GMT",
- "x-content-type-options": "nosniff",
- "content-disposition": "attachment; filename=sample_pdf.pdf",
- "content-length": "3028",
- "x-request-id": "fbc2deff-8066-11e7-9271-02420a000109",
- "content-type": "application/pdf"
}
Returns metadata about a person's document, including the filename and type.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}'
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Updates the document_type
and/or customer_accessible
attributes on a document.
The content of the request.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
{- "document_type": "ACCOUNT_SNAPSHOT.FINTECSYSTEMS",
- "customer_accessible": true
}
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Marks a document as deleted.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X DELETE \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/documents/{id}'
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Uploads an identification document for the person identification specified in the request URL. Note that this request uses the content-type
of multipart/form-data
and that the request body must be submitted as individual form-data
items.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X POST \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/document_upload' \ -H 'Content-Type: multipart/form-data' \ -F file=string \ -F document_type=ACCOUNT_SNAPSHOT.FINTECSYSTEMS
{- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
Returns all documents uploaded to the person identification specified in the request URL.
Successful result of the operation
Invalid request.
You are not authorized to perform this action.
The resource could not be found.
Internal server error.
Unexpected error
curl -i -X GET \ 'https://api.solaris-sandbox.de/v1/persons/{person_id}/identifications/{id}/documents?page%5Bnumber%5D=string&page%5Bsize%5D=string'
[- {
- "id": "6bb6aea0c0c9058412cd43b0b58c3e92cdoc",
- "name": "sample_pdf.pdf",
- "content_type": "application/pdf",
- "document_type": "SIGNED_CONTRACT",
- "size": 3028,
- "customer_accessible": false,
- "created_at": "2022-04-22T16:06:05Z",
- "deleted_at": "2023-04-22T16:06:05Z"
}
]
Specifies the preferred communication language for the person specified in the request URL. Note that each call to this endpoint will overwrite the previous value.
The operation was successful.
An error occurred on the client side.
The requested resource could not be found.
Internal server error.
Unexpected error
{- "language": "DE"
}
{- "language": "DE"
}