Skip to main content
PUT
Update a payee
In a not-yet-submitted submission this edits the draft payee in place. In a correction round it amends the already-reported payee; because that payee may have been reported across several packages, the correction fans out across all of them.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

submissionId
string
required
clientPayeeId
string
required

Body

application/json

A payee to report.

clientPayeeId
string
required

Your own id for this payee. Required and echoed back in the result to correlate it.

Maximum string length: 100
names
object[]
required
Required array length: 1 - 2147483647 elements
countryCode
string
required
Minimum string length: 1
Example:

"DE"

addresses
object[]
required
emails
string[]
required
webPages
string[]
required
taxes
object[]
required
accounts
object[]
required
representative
object

Payee representative (optional)

Response

200 - application/json

OK

Result of creating/updating a single payee

status
enum<string>
required
Available options:
SUCCESS,
FAILED
errors
object[]
required
clientPayeeId
string

Your clientPayeeId echoed back, to correlate this result with your record

Last modified on July 22, 2026