Submit person filing fields

Submit statutory filing fields for a person in a jurisdiction. Use this endpoint for fields returned by the required-fields endpoint with entity: "person" and scope containing "filing".

Fields are validated against the jurisdiction’s field definitions. Unknown keys are rejected.

PUT /v1/statutory/persons/{person_id}/fields/{country_code}

Submit person filing fields

cURL

curl --request PUT \
  --url https://api.cadanapay.com/v1/statutory/persons/{person_id}/fields/{country_code} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": {
    "steuerID": "97148835200",
    "personengruppenschluessel": "101"
  }
}
'

400

{
  "error": {
    "code": "invalid_request",
    "message": "countryCode is required",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey · string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

person_id · string · required

Person identifier

country_code · string · required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$

Body

application/json

Request body for submitting statutory filing fields.

fields · object · required

Key-value pairs of field data. Keys must match the key values from the jurisdiction's required-fields response.

Show child attributes

Example:

{
  "steuerID": "97148835200",
  "personengruppenschluessel": "101"
}

Response

204

Fields saved successfully