Business partner API for enrichment and ERP creation
Connect your own applications to company data enrichment. Start with a company email, domain or website, then choose a JSON result or direct ERP customer creation through the same API.
What can the Business Partner API do?
The Business Partner API enriches company data from published website information and checks an available VAT ID. One synchronous endpoint offers two modes: enrich returns the company as JSON; create additionally creates the record in every active company ERP connection. A failed VAT check sets a flag and does not stop processing.
Two outcomes from one API integration
Enrich or create
Use enrich for company data enrichment inside your application. Use create for ERP customer creation, including prospects or suppliers where the provider supports them. Creation requires a company name, domain and nonempty VAT ID after enrichment.
Company keys and user attribution
Company and system administrators manage company-owned keys with enrichment-only or creation permission. Every real request includes an existing company user email for attribution and uses the ordinary company allowance.
Connection defaults and supplied fields
Keep the configured ERP payload defaults and supplement them with supported request fields or connection-specific payload values. Caller-supplied values remain in the request draft; they do not overwrite the shared company catalog.
How it works
- 1
Create a key
A company or system administrator opens API keys in the profile menu and selects enrichment-only or ERP creation access.
- 2
Try demo data
Open API documentation from the same profile menu. Valid demo requests return a fixed example without consuming allowance or calling websites, VAT services or ERP systems.
- 3
Choose the mode
Send an email, domain or website from your server application with the company key and attributed user email. Select enrich or create. Creation uses all active connections and requires ERP writes to be enabled.
- 4
Inspect the result
Receive the enriched company, VAT status flag and, after successful creation, ERP references. Keep the same Idempotency-Key when retrying a creation request.
Example: from a sales form to an ERP prospect
An internal sales application receives a company email. It requests enrich to show company data as JSON. If your approved workflow needs a prospect in ERP, it uses create with the relevant record type and connection payload values. Existing mapped records are returned unchanged rather than updated.
Website enrichment is not company-register verification. Missing creation minimums or possible remote duplicates prevent creation. Connections can partially succeed; failed requests return safe error information, and completed ERP writes cannot be undone here. There is no generic webhook or bulk endpoint in this API.
Frequently asked questions
Do enrichment and ERP creation use different endpoints?
Which ERP systems can receive the API result?
Who can manage API keys and test live requests?
Does an unsuccessful VAT check block ERP creation?
Have a record or connection in mind?
Set up your company workspace, or describe the ERP and master data problem through Contact.