Capabilities

entities.upsert

Changed on

Create a new legal entity or update an existing one.

post/capabilities/entities.upsert

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/entities.upsert
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

entityIdstring

Entity ID to update. Omit to create a new entity.

namestring required

Legal entity name

entityKind'individual' | 'organization' nullable

Whether the legal entity is an individual or organization. Null clears the assignment.

streetAddressstring

Street address

addressLine2string

Address line 2

citystring

City

stateOrProvincestring

State or province

postalCodestring

Postal/zip code

countrystring required

Country name

contactNumberstring

Phone number

emailstring

Email address

taxIdstring

Tax ID / VAT number

aliasesstring[]

Alternative names for this entity

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes