Query parameters

• limit integer

  The maximum number of customer accounts to be returned. Defaults to 30.

  Minimum value is 0, maximum value is 100.

• starting_after string

  Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

• ending_before string

  Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

• search_parameters string

  Currently, this API only supports searching by name_first or name_last. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.

Responses

• 200

  Array of Customers and their corresponding Accounts

  Hide response attributes Show response attributes object

  • results array[object] Required

    An array of information for all customer-account correspondences within the requested range.

    Not more than 1000 elements.

    Hide results attributes Show results attributes array[object]

    • customer_id string Required

      A Canopy-generated ID for the customer.

    • name_prefix string

      Prefix to the customer's name. Primary account holder or controlling officer name for Business customers.

    • name_first string

      Customer's first name. Primary account holder or controlling officer name for Business customers.

    • name_middle string

      Customer's middle name. Primary account holder or controlling officer name for Business customers.

    • name_last string

      Customer's last name. Primary account holder or controlling officer name for Business customers.

    • name_suffix string

      Suffix to the customer's name

    • phone_number string

      Customer's phone number in E.164 format

    • address_line_one string

      Address line one.

    • address_line_two string

      Address line two.

    • address_city string

      Address city.

    • address_state string

      Address state.

    • address_zip string

      Five digit zipcode or nine digit 'ZIP+4'

    • address_country_code string

      ISO 3166-1 alpha-2 country code for the customer.

      Values are US, GB, CA, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AN, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, or ZW.

      Show More
    • ssn string

      Social security number of the customer.

    • international_customer_id string

      Any country-specific unique identifier for the customer.

    • email string(email)

      The email address of this Customer

    • date_of_birth string(date)

      Customer's date of birth in ISO 8601 format

    • business_details object
      Hide business_details attributes Show business_details attributes object

      • business_legal_name string

        The legal name of the Business

      • doing_business_as string

        The DBA name of the Business

      • business_ein string

        EIN of the business

    • customer_account_role string

      The role of the customer for the account.

      Default value is PRIMARY.

    • customer_account_external_id string

      A unique number for the customer on the account. For instance, a credit card number. If none is provided, a Canopy-generated ID can be used.

    • customer_account_issuer_processor_config object
      Hide customer_account_issuer_processor_config attribute Show customer_account_issuer_processor_config attribute object

      • lithic object
        Hide lithic attribute Show lithic attribute object

        • lithic_card object
          Hide lithic_card attributes Show lithic_card attributes object

          • last_four string

            Last four digits of the card number

          • memo string

            Friendly name to identify the card

          • type string

            The type of card created by Lithic

            Values are SINGLE_USE, MERCHANT_LOCKED, or UNLOCKED.

    • account object
      Hide account attributes Show account attributes object

      • account_id string Required

        This is the ID used to identify the account in your system. For most use-cases, we strongly recommend using the ID from the system the account was originally created in -- for most use-cases, this is created as part of the origination system that approves a borrower. This will be the account that is used to refer to the borrower for all subsequent requests. Note: both strings and integers are accepted.

      • created_at string(date-time)

        The Date-Time which the account was created in the API.

      • effective_at string(date-time)

        The Date-Time that this account became/becomes active.

      • account_overview object
        Hide account_overview attributes Show account_overview attributes object

        • account_status string Required

          The Status of the Account. Active upon account creation.

          Values are ACTIVE, SUSPENDED, or CLOSED. Default value is ACTIVE.

        • account_status_subtype string | null

          The subtype of the Status of the Account. Null upon account creation.

          Values are , INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, or RISK. Default value is empty.

        • is_active_scra boolean

          Denotes whether an account has active SCRA benefits

      • account_product object

        The product associated with the account.

        Hide account_product attributes Show account_product attributes object

        • product_id string Required

          The Canopy-generated ID for the product.

        • product_overview object
          Hide product_overview attributes Show product_overview attributes object

          • product_name string Required

            Name of Product, i.e. Express Card.

          • product_color string

            A color to be associated with the product for UI purposes.

            Default value is #4867FF.

          • product_short_description string | null

            Short description of the Product - max of 30 characters.

          • product_long_description string | null Required

            Description of the Product.

          • product_time_zone string

            Timezone denoted as an Olson-style timezone defining the timezone for the product. All times in any response data for accounts using this product will be denominated in this timezone. Shifts due to daylight savings will be accounted for where relevant, and all output timestamps will be denoted as UTC offsets normalized based on this value.

            Default value is America/New_York.

          • product_type string Required

            The Type of Product. If not included, defaults to REVOLVING

        • product_lifecycle object
          Hide product_lifecycle attributes Show product_lifecycle attributes object

          • late_fee_impl_cents integer Required

            The fee charged for late payments on the account.

            Default value is 0.

          • payment_reversal_fee_impl_cents integer Required

            The fee charged for payment reversals on the account.

            Default value is 0.

          • origination_fee_impl_cents integer

            The fee charged at the time of account origination

            Default value is 0.

          • annual_fee_impl_cents integer

            An annual fee to be charged yearly from the date of account creation. It will reflect on the subsequent statement once incurred.

            Default value is 0.

          • monthly_fee_impl_cents integer

            A monthly fee to be charged monthly from the date of account creation. It will reflect on the subsequent statement once incurred.

            Default value is 0.

          • loan_end_date string(date-time) | null

            If applicable, the account's loan repayment date.

        • promo_overview object
          Hide promo_overview attributes Show promo_overview attributes object

          • promo_purchase_window_inclusive_start string(date-time) | null

            If applicable, the start date for a purchase window for the account

          • promo_purchase_window_exclusive_end string(date-time) | null

            If applicable, the end date for a purchase window for the account

          • promo_inclusive_start string(date-time) | null

            If applicable, the start date for a promotional period for the account.

          • promo_exclusive_end string(date-time) | null

            If applicable, the start date for a promotional period for the account.

          • promo_impl_interest_rate_percent number

            The percentage interest applied to the account during the promotional period (i.e. 6.2%)

            Default value is 0.

          • promo_len integer

            Defaults to 0. The number of billing cycles from account origination during which accounts on this product are on a promotional period.

        • post_promo_overview object
          Hide post_promo_overview attributes Show post_promo_overview attributes object

          • post_promo_inclusive_start string(date-time) | null

            If applicable, the start date for a promotional period for the account.

          • post_promo_exclusive_end string(date-time) | null

            If applicable, the start date for a promotional period for the account.

          • post_promo_impl_interest_rate_percent number

            The percentage interest applied to the account during the post-promotional period (i.e. 6.2%)

            Default value is 0.

          • post_promo_len integer

            If applicable, post-promotional amortization length in cycles.

            Default value is 0.

        • product_duration_information object
          Hide product_duration_information attributes Show product_duration_information attributes object

          • promo_len integer

            The number of billing cycles from account origination during which accounts on this product are on a promotional period.

            Default value is 0.

          • promo_purchase_window_len integer

            If applicable, the number of billing cycles from account origination under which this product falls under a purchas window period.

            Default value is 0.

      • external_fields array[object]

        An Array of External Fields. These should be used to connect accounts created in Canopy to Users in your system and any connected external systems.

        Not more than 1000 elements.

        Hide external_fields attributes Show external_fields attributes array[object]

        • key string

          key: i.e. Name of the External Party

        • value string

          value: i.e. External Account ID

      • min_pay_due_cents object
        Hide min_pay_due_cents attributes Show min_pay_due_cents attributes object

        • statement_min_pay_cents integer Required

          Total amount due for the billing cycle, summing cycle principal, interest, deferred interest, and fees outstanding.

          Default value is 0.

        • min_pay_due_at string(date-time)

          The Date-Time the payment for this billing cycle is due.

      • additional_statement_min_pay_details object
        Hide additional_statement_min_pay_details attributes Show additional_statement_min_pay_details attributes object

        • statement_min_pay_charges_principal_cents integer Required

          Total principal due for the billing cycle.

          Default value is 0.

        • statement_min_pay_interest_cents integer Required

          Total interest due for the billing cycle.

          Default value is 0.

        • statement_min_pay_am_interest_cents integer Required

          The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.

          Default value is 0.

        • statement_min_pay_deferred_cents integer Required

          Total deferred interest due for the billing cycle.

          Default value is 0.

        • statement_min_pay_am_deferred_interest_cents integer Required

          The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.

          Default value is 0.

        • statement_min_pay_fees_cents integer Required

          Total fees due for the billing cycle.

          Default value is 0.

        • previous_statement_min_pay_cents integer Required

          Previous amounts due, including fees. This is a subset of statement_min_pay_cents.

          Default value is 0.

      • payment_processor_config object
        Hide payment_processor_config attributes Show payment_processor_config attributes object

        • ach object

          ACH processing configuration.

          Hide ach attributes Show ach attributes object

          • payment_processor_name string Required

            Indicates the active payment processor whose configuration will be used for ACH/Debit card payments made from the account.

            Values are NONE, REPAY, DWOLLA, MODERN_TREASURY, or CANOPY_NACHA. Default value is NONE.

          • repay_config object | null
            Hide repay_config attributes Show repay_config attributes object | null

            • ach_token string | null

              The tokenized ACH details.

            • last_four string | null

              The last four digits of the account number

          • dwolla_config object | null
            Hide dwolla_config attributes Show dwolla_config attributes object | null

            • ach_token string | null

              The tokenized ACH details.

            • last_four string | null

              The last four digits of the account number

          • modern_treasury_config object | null
            Hide modern_treasury_config attributes Show modern_treasury_config attributes object | null

            • ach_token string | null

              The tokenized ACH details.

            • last_four string | null

              The last four digits of the account number

          • canopy_nacha_config object

            Canopy will create a NACHA file for each borrower ACH payment to be sent to your bank for ACH execution.

            Hide canopy_nacha_config attributes Show canopy_nacha_config attributes object

            • bank_routing_number string Required

              Routing number is a nine-digit code based on the U.S. Bank location where your account was opened.

            • bank_account_number string Required

              Account number is an eight to ten digit number that identifies a specific account.

        • debit_card object

          Debit processing configuration.

          Hide debit_card attributes Show debit_card attributes object

          • payment_processor_name string Required

            Indicates the active payment processor whose configuration will be used for Debit card payments made from the account.

            Values are NONE, REPAY, or AUTHORIZE_NET. Default value is NONE.

          • repay_config object | null
            Hide repay_config attributes Show repay_config attributes object | null

            • card_token string | null

              The tokenized card details.

            • last_four string | null

              The last four digits of the card number

          • authorize_net_config object

            Sensitive credit or debit card information will be stored as a secured token for payments in place of the raw account details. Note: This leverages credit card payment gateways, and Canopy cannot differentiate between credit or debit cards used in this payment integration. See authorize.net payment profiles for further details.

            Hide authorize_net_config attributes Show authorize_net_config attributes object

            • customer_profile_id string

              Customer profile ID created in Authorize.net

            • customer_payment_profile_ids array[string]

              Customer payment profile ID created in Authorize.net

        • credit_card object

          Credit processing configuration.

          Hide credit_card attributes Show credit_card attributes object

          • payment_processor_name string Required

            Indicates the active payment processor whose configuration will be used for Credit card payments made from the account.

            Values are NONE or CHECKOUT. Default value is NONE.

          • checkout_config object | null
            Hide checkout_config attributes Show checkout_config attributes object | null

            • source_id string

              A Checkout.com payment source id or customer id.

            • card_token string

              The tokenized card number.

            • last_four string | null

              The last 4 digits of the card number.

            • expires_on string | null

              Expiration time for the card token.

        • autopay_enabled boolean

          Indicates whether autopay is enabled for this account. Currently, autopay is triggered 1 day prior to a payment due date. If default_payment_processor is set to NONE, autopay will not be triggered for account regardless of this field's value.

          Default value is false.

        • default_payment_processor_method string

          Configures the payment processor to be used for manual or autopay payments. This cannot be set to a value different from NONE if no valid ACH or Debit Card configs are provided.

          Values are ACH, DEBIT_CARD, CREDIT_CARD, or NONE. Default value is NONE.

      • disbursements_config object
        Hide disbursements_config attributes Show disbursements_config attributes object

        • disbursement_source_payout_entity_id string

          The payout_entity_id for this payout entity (typically a lender).

        • disbursement_split_percentages object

          Provide a disbursement breakdown if draw downs from a borrower are meant to be distributed across multiple payout entities (lenders, merchants). Borrower payout breakdown. These numbers must add up to 100%. Borrower payout breakdowns will get reflected in daily reconciliation reports.

          Hide disbursement_split_percentages attribute Show disbursement_split_percentages attribute object

          • principal array[object]
            Hide principal attributes Show principal attributes array[object]

            • payout_entity_id string

              The payout_entity_id for this payout entity.

            • split_percent number

              The percentage of borrower payouts towards principal to be allocated to this payout entity. Sum of splits for a borrower must = 100%.

      • payouts_config object
        Hide payouts_config attribute Show payouts_config attribute object

        • payout_split_percentages object
          Hide payout_split_percentages attributes Show payout_split_percentages attributes object

          • principal array[object] Required
            Hide principal attributes Show principal attributes array[object]

            • payout_entity_id string Required

              The payout_entity_id of the payout_entity.

            • split_percent number Required

              The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

          • interest array[object] Required
            Hide interest attributes Show interest attributes array[object]

            • payout_entity_id string Required

              The payout_entity_id of the payout_entity.

            • split_percent number Required

              The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

          • fee array[object] Required
            Hide fee attributes Show fee attributes array[object]

            • payout_entity_id string Required

              The payout_entity_id of the payout_entity.

            • split_percent number Required

              The percentage of borrower payouts/disbursements to be allocated to this associated entity. Sum of splits for a borrower must = 100%. No decimals allowed.

      • issuer_processor_details object
        Hide issuer_processor_details attribute Show issuer_processor_details attribute object

        • lithic object
          Hide lithic attribute Show lithic attribute object

          • account_token string(uuid)

            The external unique identifier of the Lithic account against which charges are made.

      • cycle_type object
        Hide cycle_type attributes Show cycle_type attributes object

        • first_cycle_interval string

          Interval for a first cycle for this account.

        • late_fee_grace string

          The amount of time after a payment is late after which you would like for a late fee to be incurred. If not provided, defaults to product's fee policy's late fee grace value

      • discounts object
        Hide discounts attribute Show discounts attribute object

        • prepayment_discount_config object | null
          Hide prepayment_discount_config attributes Show prepayment_discount_config attributes object | null

          • loan_discount_cents integer | null

            Loan discount amount in cents.

          • loan_discount_at string(date-time) | null

            The Date-Time that this discount is valid.

      • summary object
        Hide summary attributes Show summary attributes object

        • total_balance_cents integer

          The total balance (in cents) associated with the account. This balance is comprised of the sum of the following six balance items.

        • principal_cents integer

          The total principal balance (in cents) associated with the account.

        • interest_balance_cents integer

          The total interest balance (in cents) associated with the account.

        • interest_accrual_interval string

          The interval at which interest accrues on the account. Ex: '1 day', '1 week', '2 weeks', '1 month' .Defaults to the product interest_accrual_interval if not specified

        • am_interest_balance_cents integer

          The total AM interest balance (in cents) associated with the account.

          Default value is 0.

        • deferred_interest_balance_cents integer

          The total deferred interest balance (in cents) associated with the account.

          Default value is 0.

        • am_deferred_interest_balance_cents integer

          The total AM deferred interest balance (in cents) associated with the account.

          Default value is 0.

        • fees_balance_cents integer

          The total fees balance (in cents) associated with the account.

          Default value is 0.

        • total_paid_to_date_cents integer

          The total sum of payments made to date (in cents) associated with the account.

        • total_interest_paid_to_date_cents integer

          The total sum of interest allocations for payments made to date (in cents) associated with the account.

        • credit_limit_cents integer Required

          Total Amount (in cents) that this account can borrow.

        • max_approved_credit_limit_cents integer

          Total Amount (in cents) that this account can borrow.

          Default value is 0.

        • interest_rate_percent number

          The percentage interest applied to the account (i.e. 6.2 means 6.2%)

        • available_credit_cents integer

          The total available credit balance (in cents) for the account.

          Default value is 0.

        • open_to_buy_cents integer

          If applicable, the total amount of available funds for continued purchase following a purchase window pattern, where payments made do not replenish amount available for purchase.

          Default value is 0.

        • total_payoff_cents integer

          The total amount needed to pay off the loan at this exact moment.

          Default value is 0.

        • late_fee_cap_percent number

          Any number as a percentage (e.g. 5=> 5%). This is the maximum late fee that can be charged in this account: as determined by late_fee_cap_percent * minimum payment.

        • payment_reversal_fee_cap_percent number

          Any number as a percentage (e.g. 5=> 5%). This is the maximum reversal fee that can be charged in this account, as determined by payment_reversal_fee_cap_percent * account principal as if the payment never occurred (as opposed to after the payment but before it's reversed)

      • associated_entities object | null

        (to be depricated) -- use payout_entities instead to provide more granular detail.

        Hide associated_entities attributes Show associated_entities attributes object | null

        • merchant_name string

          A merchant name associated with the account

        • lender_name string

          A lender name associated with the account

      • plaid_config object

        Plaid configurations.

        Hide plaid_config attributes Show plaid_config attributes object

        • plaid_access_token object
          Hide plaid_access_token attribute Show plaid_access_token attribute object

          • valid_config boolean Required

            Indicates whether Canopy has a valid Plaid access token.

        • plaid_account_id object
          Hide plaid_account_id attribute Show plaid_account_id attribute object

          • valid_config boolean Required

            Indicates whether Canopy has a valid Plaid account ID.

        • check_balance_enabled boolean

          Indicates whether the balance check functionality is enabled with along side the payment processing. If set to true, the payment processing is enabled and the plaid access token and plaid account ID are valid, actions such as notifications etc. will be triggered.

          Default value is false.

      • payout_entities array[object] | null

        An array of payout entities who have been assigned to the account

        Not more than 1000 elements.

        Hide payout_entities attributes Show payout_entities attributes array[object] | null

        • payout_entity_id string Required

          The ID to be associated with the payout entity for future requests. If not provided on payout entity creation, Canopy will generate this field.

        • payout_entity_type string

          Type of associated entity

          Values are merchant, lender, sponsor, or organization.

        • payout_entity_name string

          Entity's name.

        • external_fields array[object]

          An Array of External Fields. These should be used to connect entities created in Canopy to data in your system and any connected external systems.

          Not more than 1000 elements.

          Hide external_fields attributes Show external_fields attributes array[object]

          • key string

            key: i.e. Name of the External Party

          • value string

            value: i.e. External Account ID

        • parent_payout_entity_id string | null

          A Canopy-generated ID for the parent of this associated entity to establish a parent-child relationship.

        • bank_account_number string

          Account number of the bank account for payment distributions.

        • bank_routing_number string

          Routing number of the bank account for payment distributions.

  • paging object

    Pagination Information.

    Hide paging attributes Show paging attributes object

    • starting_after string

      Use this to drive your next request if you want the next page of results

    • ending_before string

      Use this to drive your next request if you want the previous page of results

    • has_more boolean

      Indicates whether there are additional values beyond the ending index of the paginated results.

• 401

  Unauthorized.

• 403

  Forbidden.

• 404

  Unable to get customers

• 429

  Too many requests.

• default

  Unexpected Error.