POST

/v1/accounts

Bearer*
curl --request POST \
  --url https://api.oneslipstream.com/v1/accounts \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "balanceAmount": "500000",
  "consumer": "con_bPKKB3sYsukFanSsaBcMCMR2",
  "flags": {
    "consumer": "partially_settled"
  },
  "payment": {
    "amount": "10000",
    "frequency": "monthly"
  },
  "portfolio": "port_bPKKB3sYsukFanSsaBcMCMR2",
  "product": "finance_lease",
  "status": "up_to_date"
}'
{
  "id": "acc_bPKKB3sYsukFanSsaBcMCMR2",
  "balanceAmount": "500000",
  "consumer": "con_bPKKB3sYsukFanSsaBcMCMR2",
  "description": "null",
  "endAt": "2024-01-01T00:00:00.000Z",
  "flags": {
    "airtime": "null",
    "consumer": "partially_settled"
  },
  "jointPriority": "number",
  "limitAmount": "500000",
  "metadata": {
    "internalId": "12345"
  },
  "payment": {
    "amount": "10000",
    "frequency": "monthly",
    "minimumAmount": "100"
  },
  "portfolio": "port_bPKKB3sYsukFanSsaBcMCMR2",
  "product": "finance_lease",
  "reference": "null",
  "status": "up_to_date",
  "createdAt": "2022-01-01T00:00:00.000Z"
}

Authorizations

Authorizationheaderrequired
string

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
balanceAmountrequired
number

The starting balance for the account.

consumerrequired
string

The unique identifier for the consumer

description
string | null

A description of the account, this is only visible to you and is not sent to the credit bureaus

endAt
string | null

The date and time the account is due to be closed

flagsrequired
object
jointPriority
number

The priority of this account of all the holders of this account, this is only applicable to joint accounts. If the priority is 0 then this account is the primary account.

limitAmount
number

The starting credit limit for the account, this is only applicable to certain account types.

metadata
object

Set of key-value pairs that you can attach to an object, useful for storing additional information about the object in a structured format

paymentrequired
object
portfoliorequired
string

The unique identifier for the portfolio

productrequired
enum<string>

The type of product that the account is associated with.

  • hire_purchase - The product remains the property of the lender until all repayments have been made.
  • unsecured_loan - A fixed amount loan that is not secured against any asset.
  • mortgage - A loan secured against a property by a mortgage deed.
  • revolving_credit - A credit facility that allows the customer to borrow up to a pre-agreed limit and repay the amount borrowed at any time.
  • credit_card - A credit facility that allows the customer to spend up to a pre-agreed limit and repay at any time.
  • charge_card - A credit facility that allows the customer to spend up to a pre-agreed limit but repay the full amount at the end of each month.
  • rental - A product that a customer makes regular payments to use but the underlying asset remains the property of the lender.
  • mail_order - For all types of mail order portfolios.
  • current_account - A bank account that allows the customer to make payments in and out of the account.
  • second_mortgage - A loan secured against a property but the security ranks after the primary mortgage.
  • credit_sale - The ownership of the goods is transferred to the customer immediately on signing the agreement.
  • communications - For goods/service provided by a communication service provider (e.g. mobile phone, broadband, etc.).
  • buy_now_pay_later - For goods/services where the first payment is deferred for an agreed period.
  • variable_hire_purchase - For goods/services where the monthly payment can vary depeding on the base rate.
  • utility - For goods/services provided by a utility provider (e.g. water, gas, electricity, etc.).
  • finance_lease - A product where lender is not at risk since the payments cover the cost of the asset plus charges.
  • operating_lease - A product where the customer pays less than 90% of the cost of the asset, and the lender carries some of the risk.
  • bounced_cheque - For companies that provide cheque guarantee services.
  • flexible_mortgage - A loan secured against a property by a mortgage deed where the terms are flexible. This also includes combined products i.e. a mortgage with a current account.
  • consolidated_debt - When a customer has multiple loans that are transferred to another CAIS member for the purpose of debt recovery.
  • combined_credit - An account with multiple credit facilities.
  • payday_loan - A short term loan that is repaid on the customer's next payday, no more than 31 days after the loan is taken out.
  • balloon_hired_purchase - A product where the customer makes regular payments and a finaly repayment at which point the ownership of the asset transfers to the customer.
  • residential_mortgage - A loan secured against a property by a mortgage deed where the property is the customer's main residence.
  • buy_to_let_mortgage - A loan secured against a property by a mortgage deed where the property is not occupied by the customer.
  • excess_ltv_mortgage - A loan secured against a property by a mortgage deed where the loan to value ratio is greater than 100%.
  • offset_current_mortgage - A loan secured against a property by a mortgage deed where the customer's current account offsets the interest charged.
  • offset_investment_mortgage - A loan secured against a property by a mortgage deed where the customer's investment account offsets the interest charged.
  • shared_mortgage - A loan secured against a property by a mortgage deed where the ownership is shared by multiple parties.
  • liability_guarantee - A product where there is a pontential liability to the consumer.
  • store_card - A credit facility that allows the customer to spend up to a pre-agreed limit and repay at any time. These are issued for use at specific retailers or groups.
  • multi_function_card - A card with multiple functions (e.g. credit, debit, charge, etc.).
  • water - For goods/services provided by a water provider.
  • gas - For goods/services provided by a gas provider.
  • electricity - For goods/services provided by an electricity provider.
  • oil - For goods/services provided by an oil provider.
  • dual_fuel - For goods/services provided by a dual fuel provider.
  • fuel_card - For goods/services issued via a card. This excludes motoring fuel cards.
  • home_insurance - For products provided by a house insurance provider.
  • car_insurance - For products provided by a car insurance provider.
  • life_insurance - For products provided by a life insurance provider.
  • health_insurance - For products provided by a health insurance provider.
  • card_protection - For payment protection services on cards.
  • mortgage_protection - For payment protection services on mortgages.
  • payment_protection - For general payment protection services.
  • mobile - For goods/services provided by a mobile phone provider.
  • fixed_line - For goods/services provided by a fixed line provider.
  • cable - For goods/services provided by a cable provider.
  • satellite - For goods/services provided by a satellite provider.
  • business_line - For goods/services provided by a business line provider.
  • broadband - For goods/services provided by a broadband provider.
  • multi_communications - For muliple goods/services provided by a communications provider (e.g. mobile, fixed line, broadband, etc.).
  • student_loan - For education loans provided under the terms of legislation, usually controlled by the Department for Education used by the student loan company.
  • home_credit - For flexible credit products where payments are collected from the customer's home.
  • education - For education products.
  • unsecured_mortgage_loan - For loans secured against a property by a mortgage deed but there is an unsecured element e.g. A mortgage with a ratio of 100% LTV and a 10% unsecured element.
  • gambling - For gambling products (e.g. spread betting, etc.).
  • bank_account - A bank account that allows the customer to make payments in and out of the account, however no overdraft facility is available.
Available options:
hire_purchase,
unsecured_loan,
mortgage,
revolving_credit,
credit_card,
charge_card,
rental,
mail_order,
current_account,
second_mortgage,
credit_sale,
communications,
buy_now_pay_later,
variable_hire_purchase,
utility,
finance_lease,
operating_lease,
bounced_cheque,
flexible_mortgage,
consildated_debt,
combined_credit,
payday_loan,
balloon_hired_purchase,
residential_mortgage,
buy_to_let_mortgage,
excess_ltv_mortgage,
offset_current_mortgage,
offset_investment_mortgage,
shared_mortgage,
liability_guarantee,
store_card,
multi_function_card,
water,
gas,
electricity,
oil,
duel_fuel,
fuel_card,
house_insurance,
car_insurance,
life_insurance,
health_insurance,
card_protection,
mortgage_protection,
payment_protection,
mobile,
fixed_line,
cable,
satellite,
business_line,
broadband,
multi_communications,
student_loan,
home_credit,
education,
unsecured_mortgage_loan,
gambling,
bank_account
reference
string

The account reference number if this customer has previously been reported otherwise leave this blank

statusrequired
enum<string>
Available options:
unclassified,
dormant,
up_to_date,
one_month_late,
two_months_late,
three_months_late,
four_months_late,
five_months_late,
six_months_late,
defaulted

Response

200 - application/json
idrequired
string

The unique identifier for the account

balanceAmountrequired
number

The starting balance for the account.

consumerrequired
string

The unique identifier for the consumer

description
string | null

A description of the account, this is only visible to you and is not sent to the credit bureaus

endAt
string | null

The date and time the account is due to be closed

flagsrequired
object
jointPriority
number

The priority of this account of all the holders of this account, this is only applicable to joint accounts. If the priority is 0 then this account is the primary account.

limitAmount
number

The starting credit limit for the account, this is only applicable to certain account types.

metadata
object

Set of key-value pairs that you can attach to an object, useful for storing additional information about the object in a structured format

paymentrequired
object
portfoliorequired
string

The unique identifier for the portfolio

productrequired
enum<string>

The type of product that the account is associated with.

  • hire_purchase - The product remains the property of the lender until all repayments have been made.
  • unsecured_loan - A fixed amount loan that is not secured against any asset.
  • mortgage - A loan secured against a property by a mortgage deed.
  • revolving_credit - A credit facility that allows the customer to borrow up to a pre-agreed limit and repay the amount borrowed at any time.
  • credit_card - A credit facility that allows the customer to spend up to a pre-agreed limit and repay at any time.
  • charge_card - A credit facility that allows the customer to spend up to a pre-agreed limit but repay the full amount at the end of each month.
  • rental - A product that a customer makes regular payments to use but the underlying asset remains the property of the lender.
  • mail_order - For all types of mail order portfolios.
  • current_account - A bank account that allows the customer to make payments in and out of the account.
  • second_mortgage - A loan secured against a property but the security ranks after the primary mortgage.
  • credit_sale - The ownership of the goods is transferred to the customer immediately on signing the agreement.
  • communications - For goods/service provided by a communication service provider (e.g. mobile phone, broadband, etc.).
  • buy_now_pay_later - For goods/services where the first payment is deferred for an agreed period.
  • variable_hire_purchase - For goods/services where the monthly payment can vary depeding on the base rate.
  • utility - For goods/services provided by a utility provider (e.g. water, gas, electricity, etc.).
  • finance_lease - A product where lender is not at risk since the payments cover the cost of the asset plus charges.
  • operating_lease - A product where the customer pays less than 90% of the cost of the asset, and the lender carries some of the risk.
  • bounced_cheque - For companies that provide cheque guarantee services.
  • flexible_mortgage - A loan secured against a property by a mortgage deed where the terms are flexible. This also includes combined products i.e. a mortgage with a current account.
  • consolidated_debt - When a customer has multiple loans that are transferred to another CAIS member for the purpose of debt recovery.
  • combined_credit - An account with multiple credit facilities.
  • payday_loan - A short term loan that is repaid on the customer's next payday, no more than 31 days after the loan is taken out.
  • balloon_hired_purchase - A product where the customer makes regular payments and a finaly repayment at which point the ownership of the asset transfers to the customer.
  • residential_mortgage - A loan secured against a property by a mortgage deed where the property is the customer's main residence.
  • buy_to_let_mortgage - A loan secured against a property by a mortgage deed where the property is not occupied by the customer.
  • excess_ltv_mortgage - A loan secured against a property by a mortgage deed where the loan to value ratio is greater than 100%.
  • offset_current_mortgage - A loan secured against a property by a mortgage deed where the customer's current account offsets the interest charged.
  • offset_investment_mortgage - A loan secured against a property by a mortgage deed where the customer's investment account offsets the interest charged.
  • shared_mortgage - A loan secured against a property by a mortgage deed where the ownership is shared by multiple parties.
  • liability_guarantee - A product where there is a pontential liability to the consumer.
  • store_card - A credit facility that allows the customer to spend up to a pre-agreed limit and repay at any time. These are issued for use at specific retailers or groups.
  • multi_function_card - A card with multiple functions (e.g. credit, debit, charge, etc.).
  • water - For goods/services provided by a water provider.
  • gas - For goods/services provided by a gas provider.
  • electricity - For goods/services provided by an electricity provider.
  • oil - For goods/services provided by an oil provider.
  • dual_fuel - For goods/services provided by a dual fuel provider.
  • fuel_card - For goods/services issued via a card. This excludes motoring fuel cards.
  • home_insurance - For products provided by a house insurance provider.
  • car_insurance - For products provided by a car insurance provider.
  • life_insurance - For products provided by a life insurance provider.
  • health_insurance - For products provided by a health insurance provider.
  • card_protection - For payment protection services on cards.
  • mortgage_protection - For payment protection services on mortgages.
  • payment_protection - For general payment protection services.
  • mobile - For goods/services provided by a mobile phone provider.
  • fixed_line - For goods/services provided by a fixed line provider.
  • cable - For goods/services provided by a cable provider.
  • satellite - For goods/services provided by a satellite provider.
  • business_line - For goods/services provided by a business line provider.
  • broadband - For goods/services provided by a broadband provider.
  • multi_communications - For muliple goods/services provided by a communications provider (e.g. mobile, fixed line, broadband, etc.).
  • student_loan - For education loans provided under the terms of legislation, usually controlled by the Department for Education used by the student loan company.
  • home_credit - For flexible credit products where payments are collected from the customer's home.
  • education - For education products.
  • unsecured_mortgage_loan - For loans secured against a property by a mortgage deed but there is an unsecured element e.g. A mortgage with a ratio of 100% LTV and a 10% unsecured element.
  • gambling - For gambling products (e.g. spread betting, etc.).
  • bank_account - A bank account that allows the customer to make payments in and out of the account, however no overdraft facility is available.
Available options:
hire_purchase,
unsecured_loan,
mortgage,
revolving_credit,
credit_card,
charge_card,
rental,
mail_order,
current_account,
second_mortgage,
credit_sale,
communications,
buy_now_pay_later,
variable_hire_purchase,
utility,
finance_lease,
operating_lease,
bounced_cheque,
flexible_mortgage,
consildated_debt,
combined_credit,
payday_loan,
balloon_hired_purchase,
residential_mortgage,
buy_to_let_mortgage,
excess_ltv_mortgage,
offset_current_mortgage,
offset_investment_mortgage,
shared_mortgage,
liability_guarantee,
store_card,
multi_function_card,
water,
gas,
electricity,
oil,
duel_fuel,
fuel_card,
house_insurance,
car_insurance,
life_insurance,
health_insurance,
card_protection,
mortgage_protection,
payment_protection,
mobile,
fixed_line,
cable,
satellite,
business_line,
broadband,
multi_communications,
student_loan,
home_credit,
education,
unsecured_mortgage_loan,
gambling,
bank_account
reference
string

The account reference number if this customer has previously been reported otherwise leave this blank

statusrequired
enum<string>
Available options:
unclassified,
dormant,
up_to_date,
one_month_late,
two_months_late,
three_months_late,
four_months_late,
five_months_late,
six_months_late,
defaulted
createdAt
string

The date and time the account was created