Create an portfolio

Slipstream

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

bearerAuth

Authorization

The type of share account:
  * `asset_discounting` - Asset Discounting
  * `agricultural_finance` - Agricultural Finance
  * `airtime_agreement_monthly` - Airtime Agreement Monthly
  * `airtime_agreement_upfront` - Airtime Agreement Upfront
  * `balloon_repayment_loan` - Balloon Repayment Loan
  * `book_music_video_club` - Book Music Video Club
  * `budget_account` - Budget Account
  * `balloon_hp` - Balloon HP
  * `buildings_insurance` - Buildings Insurance
  * `bank` - Bank
  * `unsecured_business_loan` - Unsecured Business Loan
  * `residential_buy_to_let` - Residential Buy To Let
  * `bnpl` - Buy Now Pay Later
  * `broadband` - Broadband
  * `brewery_loan` - Brewery Loan
  * `business_line` - Business Line
  * `builders_merchant_credit` - Builders Merchant Credit
  * `current_account` - Current Account
  * `cable` - Cable
  * `credit_card` - Credit Card
  * `crown_debt` - Crown Debt
  * `charge_card` - Charge Card
  * `contents_insurance` - Contents Insurance
  * `commercial_mortgage` - Commercial Mortgage
  * `company_credit_card` - Company Credit Card where the individual responsible for debt
  * `personal_contract_purchase` - Personal Contract Purchase
  * `consumer_goods_rental` - Consumer Goods Rental
  * `unsecured_car_loan` - Unsecured Car Loan
  * `council_tax` - Council Tax
  * `credit_sale` - Credit Sale
  * `conditional_sale` - Conditional Sale
  * `combined_credit_account` - Combined Credit Account
  * `consolidated_debt` - Consolidated Debt
  * `debit_card` - Debit Card
  * `bank_defalut` - Bank Default
  * `deferred_hp` - Deferred Hire Purchase
  * `shared_ownership_mortgage` - Shared Ownership Mortgage (Housing Association)
  * `deferred_payment` - Deferred Payment
  * `dual_fuel` - Dual Fuel
  * `e_cash` - E-Cash
  * `education` - Education
  * `electricity_even_payment` - Electricity (even payment)
  * `employer_loan` - Employer Loan
  * `water_even_payment` - Water (even payment)
  * `fuel_card` - Fuel Card (individual responsible for debt)
  * `fixed_term_deferred_payment_loan` - Fixed Term Deferred Payment Loan
  * `finance_lease` - Finance Lease
  * `flexible_mortgage` - Flexible Mortgage
  * `first_mortgage_with_investment_offset` - First Mortgage with Investment Offset
  * `further_secured_loan` - Further Secured Loan
  * `factoring` - Factoring
  * `gambling` - Gambling
  * `gas_even_payment` - Gas (even payment)
  * `general_insurance` - General Insurance
  * `guarantee_liability` - Guarantee Liability
  * `home_shopping_agency` - Home Shopping Agency
  * `home_credit` - Home Credit
  * `home_shopping_direct` - Home Shopping Direct
  * `household_insurance` - Household Insurance
  * `hire_purchase` - Hire Purchase
  * `home_shopping` - Home Shopping
  * `home_shopping_cash` - Home Shopping Cash
  * `internet_credit_line` - Internet Credit Line
  * `advance_against_income` - Advance Against Income
  * `residential_second_mortgage_with_investment_offset` - Residential Second Mortgage with Investment Offset
  * `insurance` - Insurance
  * `internet_shopping` - Internet Shopping
  * `loan_unspecified_type` - Loan (Unspecified Type)
  * `life_policy_loan` - Life Policy Loan
  * `local_rates_even_payment_scheme` - Local Rates (even payment scheme)
  * `lease` - Lease
  * `landline_telephone_even_payment` - Landline Telephone (even payment)
  * `mail_order_agency` - Mail Order Agency
  * `multifunctional_card` - Multifunctional Card
  * `mortgage_unspecified_type` - Mortgage (Unspecified Type)
  * `motor_insurance` - Motor Insurance
  * `motor_finance_loan` - Motor Finance Loan
  * `semi_commercial_first_mortgage` - Semi Commercial First Mortgage
  * `mail_order` - Mail Order
  * `mortgage_protection` - Mortgage Protection
  * `mortgage_and_unsecured_loan` - Mortgage and Unsecured Loan
  * `multi_communications` - Multi Communications
  * `semi_commercial_second_mortgage` - Semi Commercial Second Mortgage
  * `mail_order` - Mail Order
  * `mortgage_protection` - Mortgage Protection
  * `mortgage_and_unsecured_loan` - Mortgage and Unsecured Loan
  * `multi_communications` - Multi Communications
  * `semi_commercial_second_mortgage` - Semi Commercial Second Mortgage
  * `option_account` - Option Account
  * `overdraft` - Overdraft
  * `oil` - Oil
  * `operating_lease` - Operating Lease
  * `investment_offset_mortgage` - Investment Offset Mortgage
  * `other_rental` - Other Rental
  * `personal_health_insurance` - Personal Health Insurance
  * `payment_protection` - Payment Protection
  * `property_rental` - Property Rental
  * `airtime_agreement_quarterly` - Airtime Agreement (quarterly)
  * `electricity_quarterly` - Electricity (quarterly)
  * `gas_quarterly` - Gas (quarterly)
  * `landline_telephone_quarterly` - Landline Telephone (quarterly)
  * `utility_quarterly` - Utility (quarterly)
  * `water_quarterly` - Water (quarterly)
  * `revolving_credit` - Revolving Credit
  * `repayment_grant` - Repayment Grant
  * `retail_store_card` - Retail Store Card
  * `rental_agreement` - Rental Agreement
  * `stock_broking_account` - Stock Broking Account
  * `secured_business_loan` - Secured Business Loan
  * `secured_card_loan` - Secured Card Loan
  * `secured_car_loan` - Secured Car Loan
  * `secured_loan` - Secured Loan
  * `student_loan` - Student Loan
  * `residential_second_mortgage` - Residential Second Mortgage
  * `offset_loan` - Offset Loan
  * `satellite` - Satellite
  * `stationery_supplier` - Stationery Supplier
  * `store_card` - Store Card
  * `offset_current_account` - Offset Current Account
  * `term_loan` - Term Loan
  * `telecommunications_supplier` - Telecommunications Supplier
  * `trade_credit` - Trade Credit
  * `tv_shopping` - TV Shopping
  * `utility_even_payment` - Utility (even payment)
  * `unsecured_loan` - Unsecured Loan
  * `utility` - Utility
  * `variable_subscription` - Variable Subscription
  * `weekly_installment_plan` - Weekly Installment Plan
  * `residential_first_time_buyer` - Residential First Time Buyer
  * `standby_credit` - Standby Credit
  * `zero_finance_loan` - Zero Finance Loan
  * `hundered_plus_ltv_mortgage` - 100% + LTV Mortgage


The unique identifier for the account event

The status of the account holder * `deceased` - The account holder is deceased * `gone_away` - The account holder has gone away * `normal` - The account holder is normal * `guardian` - The account holder is a Guardian/Power of Attorney * `uncontactable` - The account holder is uncontactable


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

The date and time the account is due to be closed

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.

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

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.


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

The status code for the account:
  * `early_delinquency` - General code to indicate early delinquency
  * `arrangement_to_pay` - Arrangement to pay
  * `sustained_delinquency` - General code to indicate sustained delinquency
  * `debt_assignment` - Debt assignment
  * `default` - Default
  * `debt_management_program` - Debt management program
  * `deferred_start` - Deferred start
  * `dormant_inactive_account` - Dormant/inactive account
  * `third_party_payment` - Supplied when full or part payments are being made by a third party, such as an Insurance Company, DSS or tenants
  * `insurance_claim_pending` - Insurance claim pending
  * `low_start_repayment_plan` - Low start repayment plan applies
  * `minimum_payment` - Minimum payment made
  * `overpayment_in_arrears` - Overpayment (in arrears)
  * `okay` - Okay (repayment requirements fulfilled)
  * `overpayment` - Overpayment
  * `payment_holiday` - Payment holiday
  * `partial_settlement` - Partial settlement
  * `query` - Query (account under review)
  * `account_reinstatement` - Account re-instatement
  * `enforced_repossession` - Enforced repossession
  * `satisfied` - Satisfied
  * `settled_closed` - Settled/closed
  * `unclassified` - Unclassified or recently opened account payment delay
  * `voluntary_arrangement` - Voluntary arrangement
  * `voluntary_repossession` - Voluntary repossession
  * `voluntary_termination` - Voluntary termination


Whether the account is now in a collection status.

Whether the account is now in a consolidating debt status.

Whether the account is now in a promotional status.

The payment amount to the nearest unit e.g. 50000 = £500.00

An arbitrary string attached to the object

The amount to the nearest unit e.g. 50000 = £500.00

The iso currency code
  * `EUR` - Euro
  * `GBP` - Great British Pound
  * `USD` - United States Dollar


The status of the payment event
  * `defaulted` - The customer has defaulted on the payment
  * `resolved` - The customer has resolved the default on the payment


The frequency of the repayment
  * `annually` - Annually
  * `deferred` - Deferred
  * `fortnightly` - Fortnightly (every 2 weeks)
  * `four_weekly` - Every 4 weeks
  * `monthly` - Monthly
  * `periodically` - Periodically
  * `quarterly` - Quarterly
  * `single_payment` - Single Payment
  * `weekly` - Weekly
  * `unknown` - Unknown


The group of the share account
  * `loan_and_installment_credit` - Loan and Installment Credit
  * `mortgage` - Mortgage
  * `revolving_credit_and_budget` - Revolving Credit and Budget
  * `telecommunications` - Telecommunications
  * `utilities` - Utilities
  * `home_shopping` - Home Shopping
  * `bank` - Bank
  * `miscellaneous` - Miscellaneous
  * `insurance` - Insurance
  * `home_credit` - Home Credit


The lowercase raw address of the consumer from the judgement

The name of the court where the judgement was issued

The type of court where the judgement was issued

The raw date of birth of the consumer from the judgement

The lowercase raw name of the consumer from the judgement

The lowercase raw address of the consumer from the notice of correction

The date the notice of correction was raised/created

The lowercase raw name of the consumer from the notice of correction

The reference number of the notice of correction

The status of the payment event
  * `success` - The payment was successful
  * `insufficient_funds` - The payment failed because there were insufficient funds in the account
  * `processing_error` - The payment failed because of a processing error (e.g. the card issuer declined the payment)


The payment status code for the account:
  * `no_update_received` - No update received
  * `up_to_date` - Account up-to-date or less than the equivalent of one PAE (payment arrears equivalent) in arrears
  * `unknown` - Unknown or unspecified
  * `one_pae` - Account in arrears by the equivalent of at least one but less than two PAE
  * `two_pae` - Account in arrears by the equivalent of at least two but less than three PAE
  * `three_pae` - Account in arrears by the equivalent of at least three but less than four PAE
  * `four_pae` - Account in arrears by the equivalent of at least four but less than five PAE
  * `five_pae` - Account in arrears by the equivalent of at least five but less than six PAE
  * `six_pae` - Account in arrears by six or more PAE
  * `default` - Account is in Default


The description of the portfolio, this is for your reference only.

The name of the portfolio, this is for your reference only.

The maximum overdraft amount for the portfolio before it's reported to the credit bureau. Defaults to 0.

The reference of the portfolio, this is issued by the credit bureau.

Address line 2 (e.g., apartment, suite, unit, or building).

The purpose of the search.
  * `quotation` - Used prior to a credit application to offer a quote (sometimes called a soft search)


The status code for the share account:
  * `default` - Default
  * `satisfied` - Satisfied
  * `normal` - Normal
  * `delinquent` - Delinquent
  * `settled` - Settled


The supplier code for the account:
  * `agricultural_finance` - Agricultural Finance
  * `bank_finance` - Bank Finance
  * `bank` - Bank
  * `building_society` - Building Society
  * `transunion` - TransUnion
  * `credit_broker` - Credit Broker
  * `credit_card_company` - Credit Card Company
  * `cc_consumer_data_capture` - CC Consumer Data Capture
  * `credit_union` - Credit Union
  * `debt_collection_agency` - Debt Collection Agency
  * `eurodirect` - EuroDirect
  * `factoring` - Factoring
  * `finance_housing` - Finance Housing
  * `finance_house` - Finance House
  * `government` - Government
  * `home_credit` - Home Credit
  * `home_shopping` - Home Shopping
  * `insurance_company` - Insurance Company
  * `internet_on_line_service` - Internet/On Line Service
  * `leasing_company` - Leasing Company
  * `mortgage_company` - Mortgage Company
  * `motor_vehicle_finance_company` - Motor Vehicle Finance Company
  * `mail_order` - Mail Order
  * `rental_company` - Rental Company
  * `retailer` - Retailer
  * `securities` - Securities
  * `student_loan` - Student Loan
  * `stockbroker` - Stockbroker
  * `telecommunications_supplier` - Telecommunications Supplier
  * `utility` - Utility
  * `vehicle_rental` - Vehicle Rental


Apache 2.0

Changelog

Request Access

Dashboard

Slipstream provides a developer-friendly API to access credit bureau data.

Overview

Documentation

The Slipstream API uses bearer token authentication. You can view your API keys in the Slipstream dashboard.

Introduction

Slipstream API

Create an portfolio

Authorizations

Body

Response