Configure credit reporting details for your organization

View as Markdown
PUT /organization/credit_reporting
application/json

Body

Set your credit reporting configurations for your organization.

  • transunion_program_identifier string

    If included, a metro2 report will be generated for your organization which uses this code to report to TransUnion.

  • experian_program_identifier string

    If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

  • equifax_program_identifier string

    If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

  • program_date string(date)

    The date your program started reporting credit to the bureaus.

  • reporter_name string

    Your organization's name, as reporting to the credit bureaus.

  • reporter_address_line_one string

    Reporter address line one.

  • reporter_address_line_two string

    Reporter address line two.

  • reporter_address_city string

    Reporter address city.

  • reporter_address_state string

    Address state.

    Values are AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, or WY.

  • reporter_address_zip string

    Reporter address, five digit zipcode or nine digit 'ZIP+4'.

  • reporter_phone_number string

    Reporter's phone number in E.164 format.

Responses

  • 200 application/json

    Issuer processor configuration for your organization

    Hide response attributes Show response attributes object
    • transunion_program_identifier string

      If included, a metro2 report will be generated for your organization which uses this code to report to TransUnion.

    • experian_program_identifier string

      If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

    • equifax_program_identifier string

      If included, a metro2 report will be generated for your organization which uses this code to report to Experian.

    • program_date string(date)

      The date your program started reporting credit to the bureaus.

    • reporter_name string

      Your organization's name, as reporting to the credit bureaus.

    • reporter_address_line_one string

      Reporter address line one.

    • reporter_address_line_two string

      Reporter address line two.

    • reporter_address_city string

      Reporter address city.

    • reporter_address_state string

      Address state.

      Values are AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, or WY.

    • reporter_address_zip string

      Reporter address, five digit zipcode or nine digit 'ZIP+4'.

    • reporter_phone_number string

      Reporter's phone number in E.164 format.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

PUT /organization/credit_reporting
curl \
 --request PUT 'https://sandbox-api.canopyservicing.com/organization/credit_reporting' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"transunion_program_identifier":"5555555555","experian_program_identifier":"5555555555","equifax_program_identifier":"5555555555","program_date":"1985-06-20","reporter_name":"Acme Corporation","reporter_address_line_one":"12 Strawberry Road","reporter_address_line_two":"Suite 101","reporter_address_city":"Atlanta","reporter_address_state":"GA","reporter_address_zip":"99999-1000","reporter_phone_number":"+14105556789"}'
Request examples
{
  "transunion_program_identifier": "5555555555",
  "experian_program_identifier": "5555555555",
  "equifax_program_identifier": "5555555555",
  "program_date": "1985-06-20",
  "reporter_name": "Acme Corporation",
  "reporter_address_line_one": "12 Strawberry Road",
  "reporter_address_line_two": "Suite 101",
  "reporter_address_city": "Atlanta",
  "reporter_address_state": "GA",
  "reporter_address_zip": "99999-1000",
  "reporter_phone_number": "+14105556789"
}
Response examples (200)
{
  "transunion_program_identifier": "5555555555",
  "experian_program_identifier": "5555555555",
  "equifax_program_identifier": "5555555555",
  "program_date": "1985-06-20",
  "reporter_name": "Acme Corporation",
  "reporter_address_line_one": "12 Strawberry Road",
  "reporter_address_line_two": "Suite 101",
  "reporter_address_city": "Atlanta",
  "reporter_address_state": "GA",
  "reporter_address_zip": "99999-1000",
  "reporter_phone_number": "+14105556789"
}