Retrieve a single account opening request

Account opening
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Create an account opening request

Request

Creates an account opening request for a specific customer. See the account opening guide for more information about this process and its associated stages.

Bodyapplication/jsonrequired

customer_idstringrequired

The ID (e.g., person_id or business_id) of the customer for whom you're opening the account.

Example: "b109ee6f66d2a061e006bd31c6455df2cper"

customer_typestringrequired

The type of customer for whom you're opening an account. Use Person for B2C and Freelancer customers and Business for B2B customers.

Enum"Person""Business"

Example: "Person"

product_namestringrequired

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_typestringrequired

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_currencystringrequired

The currency of the account.

Enum"CAD""CHF""CNY""DKK""EUR""GBP""HKD""JPY""NOK""SEK"

Example: "EUR"

account_bicstringrequired

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

Enum"SOBKDEBBXXX""SOBKDEB2XXX""SOBKITM2XXX""SOBKFRP2XXX""SOBKESM2XXX"

Example: "SOBKDEB2XXX"

account_purposestring

The purpose of the account. Use primary unless otherwise instructed.

Example: "primary"

application/json

{
  "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper",
  "customer_type": "Person",
  "product_name": "CURRENT_ACCOUNT_CONSUMER_GERMANY",
  "account_type": "CHECKING_PERSONAL",
  "account_purpose": "primary",
  "account_bic": "SOBKDEB2XXX",
  "account_currency": "EUR"
}

Responses

The account opening request was successfully initiated.

Bodyapplication/json

idstring

The ID of the account opening request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08aorq"

customer_idstring

The ID (e.g., person_id or business_id) of the customer for whom you're opening the account.

Example: "b109ee6f66d2a061e006bd31c6455df2cper"

customer_typestring

The type of customer for whom you're opening an account. Use Person for B2C and Freelancer customers and Business for B2B customers.

Enum"Person""Business"

Example: "Person"

statusstring

The status of the account opening request.

Enum"INITIATED""IN_PROGRESS""COMPLETED""REJECTED"

Example: "COMPLETED"

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_purposeany

The purpose of the account. Use primary unless otherwise instructed.

Example: "primary"

account_bicstring

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_currencyany

The currency of the account.

Example: "EUR"

rejection_reasonany

The reason why the AOR was rejected.

Example: {"failed_validation":"consumer_age_over_18","details":"Customer is not over 18 years old."}

account_idstring

The ID of the account.

Example: "c5a0e32369e9372e0fdf490294cecd8dcacc"

ibanstring

The IBAN of the account.

Example: "DE49110101013998767672"

created_atstring(date-time)

The timestamp (date-time) when the AOR was created.

Example: "2021-12-22T15:05:33.634+00:00"

updated_atstring(date-time)

The timestamp (date-time) when the AOR was last updated.

Example: "2021-12-22T15:05:33.634+00:00"

Response

application/json

{
  "id": "f8d7fbbd587047a0aa449ce69d2d6c08aorq",
  "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper",
  "customer_type": "Person",
  "status": "COMPLETED",
  "product_name": "CURRENT_ACCOUNT_CONSUMER_GERMANY",
  "account_type": "CHECKING_PERSONAL",
  "account_purpose": "primary",
  "account_bic": "SOBKDEB2XXX",
  "account_currency": "EUR",
  "rejection_reason": {
    "failed_validation": "consumer_age_over_18",
    "details": "Customer is not over 18 years old."
  },
  "account_id": "c5a0e32369e9372e0fdf490294cecd8dcacc",
  "iban": "DE49110101013998767672",
  "created_at": "2021-12-22T15:05:33.634+00:00",
  "updated_at": "2021-12-22T15:05:33.634+00:00"
}

Index all account opening requests for all of your customers

Request

Returns an array containing all account opening requests for all of your customers.

Query

filter[customer_id]string

Filters the response by the customer ID.

filter[status]string(account_opening_request_status_enum)

Filters the response by the status of the account opening request (AOR).

Enum"INITIATED""IN_PROGRESS""COMPLETED""REJECTED"

Example: filter[status]=COMPLETED

filter[created_at][min]string

Filters the response by the created_at field (min border) of the AOR.

filter[created_at][max]string

Filters the response by the created_at field (max border) of the AOR.

sortstring

Sorts the returned AORs by the created_at field.

page[size]integer[ 1 .. 1000 ]

The size of each results page to return.

Default 10

page[number]integer>= 1

The number of results pages to return.

Default 1

No request payload

Responses

An error occurred on the client side.

Bodyapplication/json

idstring

Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

statusstring

Example: "400"

codestring

Example: "build_pagination_headers_failure"

titlestring

Example: "Failed to build pagination headers."

detailstring

Example: "Cannot connect to database."

Response

application/json

{
  "id": "a95f2aaf-4e0c-4d49-8021-8a16a884ed86",
  "status": "400",
  "code": "build_pagination_headers_failure",
  "title": "Failed to build pagination headers.",
  "detail": "Cannot connect to database."
}