APIPay Out endpointsVendor

Enrich vendor

View as MarkdownOpen in Claude

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.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

entrystringRequired
Entrypoint identifier.

Request

This endpoint expects an object.
vendorIdlongRequired
ID of the vendor to enrich. Must be active and belong to the given entrypoint.
scopelist of stringsOptional

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.

applyEnrichmentDatabooleanOptional

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.

invoiceFileobjectOptional

PDF invoice file, Base64-encoded. Required when scope includes invoice_scan.

billIdlongOptional
Bill ID to associate with this enrichment request.
fallbackMethodstringOptional

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

scheduleCallIfNeededbooleanOptionalBeta

When true, triggers an AI outreach call if enrichment stages return insufficient payment acceptance info. This feature is currently in development.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeinteger

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

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
roomIdlong

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.

responseDataobject
Enrichment result details.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error