Skip to main content
PATCH
/
v1
/
accounts
/
{account_id}
Update Account
curl --request PATCH \
  --url https://sandbox.api.rime.finance/v1/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_id": "<string>",
  "country": "<string>",
  "city": "<string>",
  "line1": "<string>",
  "line2": "<string>",
  "postal_code": "<string>",
  "state": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "birthdate": "<string>",
  "place_of_birth": "<string>",
  "business_name": "<string>",
  "lei": "<string>",
  "tax_id": "<string>",
  "tin": "<string>",
  "tax_residencies": "<string>"
}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "external_id": "user-12345-updated",
  "type": "individual",
  "country": "Germany",
  "city": "Munich",
  "line1": "Neue Straße 789",
  "line2": "Suite 5A",
  "postal_code": "80331",
  "state": "Bavaria",
  "first_name": "Max",
  "last_name": "Mustermann",
  "dob_day": 15,
  "dob_month": 3,
  "dob_year": 1990,
  "place_of_birth": "Munich",
  "tin": "DE123456789",
  "tax_residencies": "DE",
  "created": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization
string
header
required

Bearer access token. Provide as a Authorization: Bearer <token> header.

Path Parameters

account_id
string<uuid>
required

Body

application/json
external_id
string

External IDs are identifiers you can attach to an account to help you identify it within your system. This could be a username or user ID from your system, or any other identifier you want to use.

country
string

Country of residence or incorporation.

city
string

City of residence or incorporation.

line1
string

Primary, first line of address of residence or incorporation.

line2
string

Optional second line of address of residence or incorporation.

postal_code
string

Postal code or ZIP code of residence or incorporation.

state
string

State or province of residence or incorporation.

first_name
string

First name of the individual.

Applicable for individual accounts.

last_name
string

Last name of the individual.

Applicable for individual accounts.

birthdate
string

Date of birth.

Applicable for individual accounts.

place_of_birth
string

Place of birth.

Applicable for individual accounts.

business_name
string

Registered business name of the company.

Applicable for business accounts.

lei
string

Legal Entity Identifier of the registered business. Can be required for regulatory compliance depending on your settings.

Applicable for business accounts.

tax_id
string

Tax ID of the registered business.Is required if you opted in for tax reporting in your settings.

Applicable for business accounts.

tin
string

Tax Identification Number of the individual.Is required if you opted in for tax reporting in your settings.

Applicable for individual accounts.

tax_residencies
string

Tax residencies of the individual or registered business.Is required if you opted in for tax reporting in your settings.

Applicable for individual and business accounts.

Response

200 - application/json

Account updated successfully

id
string<uuid>

Unique identifier for the resource.

Example:

"123e4567-e89b-12d3-a456-426614174000"

external_id
string

External IDs are identifiers you can attach to an account to help you identify it within your system. This could be a username or user ID from your system, or any other identifier you want to use.

type
enum<string>

Accounts can either be for a natural person (individual) for a registered business. The type of account has an influence on the parameters required for account creation.

Available options:
individual,
business
country
string

Country of residence or incorporation.

city
string

City of residence or incorporation.

line1
string

Primary, first line of address of residence or incorporation.

line2
string

Optional second line of address of residence or incorporation.

postal_code
string

Postal code or ZIP code of residence or incorporation.

state
string

State or province of residence or incorporation.

first_name
string

First name of the individual.

Applicable for individual accounts.

last_name
string

Last name of the individual.

Applicable for individual accounts.

dob_day
number

The day of date of birth, between 1 and 31.

Applicable for individual accounts.

Example:

24

dob_month
number

The month of date of birth, between 1 and 12.

Applicable for individual accounts.

Example:

10

dob_year
integer

The four-digit year of date of birth.

Applicable for individual accounts.

Example:

1995

place_of_birth
string

Place of birth.

Applicable for individual accounts.

business_name
string

Registered business name of the company.

Applicable for business accounts.

lei
string

Legal Entity Identifier of the registered business. Can be required for regulatory compliance depending on your settings.

Applicable for business accounts.

tax_id
string

Tax ID of the registered business.Is required if you opted in for tax reporting in your settings.

Applicable for business accounts.

tin
string

Tax Identification Number of the individual.Is required if you opted in for tax reporting in your settings.

Applicable for individual accounts.

tax_residencies
string

Tax residencies of the individual or registered business.Is required if you opted in for tax reporting in your settings.

Applicable for individual and business accounts.

created
string<date-time>

Timestamp when the resource was created.

Example:

"2024-01-15T10:30:00Z"

I