Canopy API - Latest

Update Metro2 Configuration for a customer

PUT /customers/{customer_id}/metro2_config

Add Metro2 Configuration to an existing customer, or Modify the Metro2 Configuration for an existing customer, to enable Credit Reporting on for that customer.

Path parameters

customer_id string Required

ID of the Customer

Body

Update Metro2/Bloom Configuration for a Customer

bloom_metadata object

Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
- address_type string
  
  Status of the reported address.
  
  Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
- residence_type string
  
  Optional, if not available or unknown, do not report.
  
  Values are OWNS or RENTS.
- account_designations array[object] | null
  
  A list of accounts associated with the customer.
  account_id string
  
  the ID of the account associated with the customer
  
  designation string
  
  The designation of the customer for the account.
  
  Values are INDIVIDUAL, JOINT_CONTRACTUAL_LIABILITY, AUTHORIZED_USER, COMAKER_OR_GUARANTOR, MAKER, BUSINESS_COMMERCIAL, or DECEASED.

Responses

• 200 object

Customer Metro2 Configuration updated successfully
- bloom_metadata object
  
  Bloom API fields for customers: https://docs.bloom.dev/docs/furnishment-api/b3A6MjA1NTM1MQ-create-consumer
  address_type string
  
  Status of the reported address.
  
  Values are CONFIRMED, KNOWN, NOT_CONFIRMED, MILITARY, SECONDARY, BUSINESS, UNDELIVERABLE, DEFAULT, or BILL_PAYER_SERVICE.
  
  residence_type string
  
  Optional, if not available or unknown, do not report.
  
  Values are OWNS or RENTS.
  
  account_designations array[object] | null
  
  A list of accounts associated with the customer.
  
  account_id string
  
  the ID of the account associated with the customer
  
  designation string
  
  The designation of the customer for the account.
  
  Values are INDIVIDUAL, JOINT_CONTRACTUAL_LIABILITY, AUTHORIZED_USER, COMAKER_OR_GUARANTOR, MAKER, BUSINESS_COMMERCIAL, or DECEASED.
• 401

Unauthorized.
• 403

Forbidden.
• 422

Invalid input
• 429

Too many requests.
• default

Unexpected Error.

PUT /customers/{customer_id}/metro2_config

curl \
 -X PUT https://<your_environment_name>-uat-api.canopyservicing.com/customers/cust_30189/metro2_config \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"bloom_metadata":{"address_type":"CONFIRMED","residence_type":"OWNS","account_designations":[{"account_id":"string","designation":"INDIVIDUAL"}]}}'

Request example

{
  "bloom_metadata": {
    "address_type": "CONFIRMED",
    "residence_type": "OWNS",
    "account_designations": [
      {
        "account_id": "string",
        "designation": "INDIVIDUAL"
      }
    ]
  }
}

Response example (200)

{
  "bloom_metadata": {
    "address_type": "CONFIRMED",
    "residence_type": "OWNS",
    "account_designations": [
      {
        "account_id": "string",
        "designation": "INDIVIDUAL"
      }
    ]
  }
}