PUT Tax Identity

This endpoint is used to create or update a tax identity in the Sync platform to process resources that require tax identification information. The taxIdentifier acts as a unique key for each tax identity, ensuring that each entity is uniquely identified within the system.

Request

HTTP request

PUT https://api-sync-resser.azurewebsites.net/api/upsert-tax-identity

Parameters

This request does not utilize any query parameters.

Request body

Provide an object like the following:

{
    "taxIdentifier": "string",
    "legalName": "string"
}

• Required: At least one of taxIdentifier or legalName must be provided.
• taxIdentifier: Optional. If provided, must be a string with fewer than 128 characters.
• legalName: Optional. If provided, must be a string with fewer than 300 characters.
• Omitted properties: Any optional property not included will be ignored.
• Removing a property: To explicitly remove a value, set it as an empty string ("").

Response

If successful, the method returns the created or updated tax identity:

{
    "taxIdentifier": "string",
    "legalName": "string"
}

Property	Type	Description
taxIdentifier	string?	Tax identifier of the entity.
legalName	string?	Legal name of the entity.

Errors

The following table provides a list of potential error messages that the API may return in response to a call to this method. For more detailed information, please refer to the error message documentation.

Error type	Error detail	Description
badRequest (400)	BadParameters	- Neither taxIdentifier nor legalName provided. - Property values exceed limits or are misspelled.
unauthorize (401)	Unauthorize	The requester is not allowed to use this request.
forbidden (403)	Forbidden	Requester does not have permission to perform this operation.