Skip to Content
Account

Get Account Information

GET/v2/account

Get authorized account information.

Returns

▸
▸emailstring

Email of the account. Empty string for project accounts.

▸projectNamestring

Name of the project for project accounts. Empty string otherwise.

Example request
curl --location --request GET 'https://api-test.simpl.rent/v2/account' \ --header 'Authorization: <API key>'

Get Account Products

GET/v2/account/products

Retrieve available products, such as tenant verification credits.

Returns

▸
▸productsobject array

List of products available to the account.

▸typestring

Product type (FULL_CHECK | IDENTITY_CREDIT_CHECK).

▸amountnumber

Quantity of the product.

▸remainingnumber

Remaining quantity of the product.

▸createdAtstring

Date when the product was purchased.

▸validUntilstring

Date when the product will expire. Absent if the product does not expire.

Request Example
curl --location --request GET 'https://api-test.simpl.rent/v2/account/products' \ --header 'Authorization: <API key>'