Vendor

Enrich vendor

Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan, web search) based on the scope parameter. Can automatically apply extracted payment acceptance info and vendor contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable this feature.

post/Vendor/enrich/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Vendor/enrich/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

Entrypoint identifier.

Request body

vendorIdinteger required

ID of the vendor to enrich. Must be active and belong to the given entrypoint.

scopestring[]

Enrichment stages to run. Valid values are invoice_scan and web_search. Stages run in order: invoice scan first, then web search. If the vendor becomes payout-ready after invoice scan, web search is skipped.

applyEnrichmentDataboolean

When true (the default), extracted data is automatically written to the vendor record. Only empty fields are populated, existing values are never overwritten. When false, the vendor record isn't modified. In both cases, enrichmentData in the response contains the extracted results. Use false for UI flows where users review and confirm changes before applying them with the update vendor endpoint.

scheduleCallIfNeededboolean

When true, Payabli schedules an AI outreach call to the vendor if the enrichment stages return insufficient payment acceptance info. The call collects the vendor's preferred payment method and contact email. This is the third enrichment stage and is opt-in at the org level. See the schedule outreach call endpoint for behavior and requirements.

billIdinteger

Bill ID to associate with this enrichment request.

fallbackMethodstring

Payment method to apply if enrichment can't find payment details. Values are check, ach, or card.

Response

Success

responseCodeinteger

Code for the response. Learn more in API Response Codes.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.