Get a specific customer

GET /customers/{customer_id}

All the customer's information

Path parameters

Responses

  • 200 object | null

    Successful query of information for a specific customer

    • address_line_one string Required

      Address line one.

    • Address line two.

    • address_city string Required

      Address city.

    • address_state string Required

      Address state.

    • address_zip string Required

      Five digit zipcode or nine digit 'ZIP+4'.

    • 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.

    • Prefix to the customer's name.

    • Customer's first name.

    • Customer's middle name.

    • Customer's last name.

    • Suffix to the customer's name.

    • passport object
      • number string Required

        Number on the passport

      • country string Required

        ISO 3166-1 Two letter code for the issuing country

    • customer_id string Required

      An ID for the customer.

    • created_at string(date-time)

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

    • updated_at string(date-time)

      The Date-Time which the customer was updated in the API.

    • Indicates whether the customer has a borrower portal login or not

    • The customer can be either a person or a business. This is used to explicitly set that and adjust behavior such as validation.

      Values are person or business.

    • is_active boolean

      Value manually maintained - defaults to true."False" generally indicates no additional credit should be granted to this customer

    • The verification status of this customer. The default is 'unverified'. Depending on the system's configuration verification with third parties will happen and the status will be updated based on the result.

      Values are unverified, verified, retry, or document.

    • title string

      Title of the customer if a person OR title of the admin if a business

    • Customer's phone number in E.164 format

    • ssn string

      Social security number of the customer.

    • 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

      • The number of active accounts for this customer.

      • The total outstanding balance (in cents) associated with all active accounts for this customer. This balance is comprised of the sum of the following six balance items.

      • The total principal balance (in cents) associated with all active accounts for this customer.

      • The total interest balance (in cents) associated with all active accounts for this customer.

      • The total AM interest balance (in cents) associated with all active accounts for this customer.

        Default value is 0.

      • The total deferred interest balance (in cents) associated with all active accounts for this customer.

        Default value is 0.

      • The total AM deferred interest balance (in cents) associated with all active accounts for this customer.

        Default value is 0.

      • The total fees balance (in cents) associated with all active accounts for this customer.

        Default value is 0.

      • The DBA name of the Business

      • EIN of the business, expected format in NN-NNNNNNN.

      • Type of business is used in determining the appropriate validation.

        Values are sole_proprietorship, llc, unincorporated_association, trust, corporation, corporation_public, non_profile, or partnership.

      • UUID that references the business classification. This will eventually be supported by a reference api, however, for now refer to dwolla's specific UUID.

      • website string

        URL for the buesiness's website. This should be publicly resolvable

      • controller object | null

        Passport information. required if country is not US

        • address_line_one string Required

          Address line one.

        • Address line two.

        • address_city string Required

          Address city.

        • address_state string Required

          Address state.

        • address_zip string Required

          Five digit zipcode or nine digit 'ZIP+4'.

        • 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.

        • Prefix to the customer's name.

        • Customer's first name.

        • Customer's middle name.

        • Customer's last name.

        • Suffix to the customer's name.

        • passport object
          • number string Required

            Number on the passport

          • country string Required

            ISO 3166-1 Two letter code for the issuing country

        • title string

          Title of the customer if a person OR title of the admin if a business

        • Customer's phone number in E.164 format.

        • ssn string

          Social security number of the customer.

    • Metro2 credit reporting configs

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Payment Processor not found

  • 429

    Too many requests.

  • Unexpected Error.

GET /customers/{customer_id}
curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/customers/cust_30189 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200)
{
  "address_line_one": "12 Strawberry Road",
  "address_line_two": "Suite 101",
  "address_city": "Atlanta",
  "address_state": "GA",
  "address_zip": "99999-1000",
  "address_country_code": "US",
  "name_prefix": "Dr.",
  "name_first": "Miriam",
  "name_middle": "Louise",
  "name_last": "Trevino",
  "name_suffix": "Jr",
  "passport": {
    "number": "string",
    "country": "JP"
  },
  "customer_id": "31mNprzLd2bKl6koVna68ARM",
  "created_at": "2017-06-20T09:12:14+00:00",
  "updated_at": "2019-02-20T09:12:14+00:00",
  "is_borrower_portal_user": true,
  "customer_type": "person",
  "is_active": true,
  "verification_status": "verified",
  "title": "CFO",
  "phone_number": "+14105556789",
  "ssn": "888888888",
  "international_customer_id": "9999999999",
  "email": "marissa@protonmail.com",
  "date_of_birth": "1985-06-20",
  "customer_balances": {
    "num_active_accounts": 2,
    "total_balance_cents": 300000,
    "principal_cents": 200000,
    "interest_balance_cents": 60000,
    "am_interest_balance_cents": 0,
    "deferred_interest_balance_cents": 40000,
    "am_deferred_interest_balance_cents": 0,
    "fees_balance_cents": 0
  },
  "business_details": {
    "business_legal_name": "Umbrella Corporation",
    "doing_business_as": "Umbrella",
    "business_ein": "888-888888",
    "business_type": "llc",
    "business_classification_id": "794D9D5E-B547-4B3B-8289-76484C1AFC5F",
    "website": "https://example.com",
    "controller": {
      "address_line_one": "12 Strawberry Road",
      "address_line_two": "Suite 101",
      "address_city": "Atlanta",
      "address_state": "GA",
      "address_zip": "99999-1000",
      "address_country_code": "US",
      "name_prefix": "Dr.",
      "name_first": "Miriam",
      "name_middle": "Louise",
      "name_last": "Trevino",
      "name_suffix": "Jr",
      "passport": {
        "number": "string",
        "country": "JP"
      },
      "title": "CFO",
      "phone_number": "+14105556789",
      "ssn": "888888888"
    }
  },
  "metro2_config": {
    "bloom_metadata": {
      "address_type": "CONFIRMED",
      "residence_type": "OWNS",
      "account_designations": [
        {
          "account_id": "string",
          "designation": "INDIVIDUAL"
        }
      ]
    }
  }
}