Skip to main content
GET
Get customer document requirements and shipper rules
Read the Customer requirements guide before interpreting conditional checks or customer waivers.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

id
string
required

Upwell customer ID. Resolve it through the customer API when starting with a source-system ID.

Response

Resolved settings, or null when the customer is not visible. Check for body-level errors before using the result.

Settings response.

customerRequirements
CustomerRequirements · object | null

Effective settings for one accessible customer.