Path parameters

• customer_id string Required

  Customer ID

Responses

• default

  Unexpected Error.

• 200

  Successful query of information for a specific customer

  Hide response attributes Show response attributes 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.

  • 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

• 401

  Unauthorized.

• 403

  Forbidden.

• 404

  Customer not found

• 422

  Invalid input

• 429

  Too many requests.