Commenda OS Partner API

https://api.prod.commenda.io/api/v1/partner/commenda-os

​

Authentication

curl --request GET \
  --url 'https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/77/business-entities' \
  --header 'x-api-key: <partner_api_key>'

​

Response conventions

• List endpoints return { <resourcePlural>, count }.
• Detail endpoints return { <resourceSingular> }.
• All customer-scoped Commenda OS partner endpoints are scoped by customerId.
• Requests without a valid x-api-key return 401 with Missing x-api-key header or Invalid API key.
• Customer-scoped endpoints return 403 when the partner cannot access the requested customer.
• Business-entity-scoped collection endpoints return 404 Business entity not found when the businessEntityId does not belong to the specified customer.
• Child detail endpoints return resource-specific 404 messages such as Location not found, Government identifier not found, or Registration not found.

​

Available resources

• Business entities
• Create business entities
• Update business entities
• Locations
• Persons
• Government identifiers
• Upload files
• List business entity documents
• Registrations