Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutSupplementalTaxRegistration

Stores supplemental tax registration for a single account.

Request Syntax


POST /PutSupplementalTaxRegistration HTTP/1.1
Content-type: application/json

{
   "taxRegistrationEntry": { 
      "address": { 
         "addressLine1": "string",
         "addressLine2": "string",
         "addressLine3": "string",
         "city": "string",
         "countryCode": "string",
         "districtOrCounty": "string",
         "postalCode": "string",
         "stateOrRegion": "string"
      },
      "legalName": "string",
      "registrationId": "string",
      "registrationType": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

taxRegistrationEntry

The supplemental TRN information that will be stored for the caller account ID.

Type: SupplementalTaxRegistrationEntry object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "authorityId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

authorityId

Unique authority ID for the supplemental TRN information that was stored.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[\s\S]*$

status

The status of the supplemental TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending, Rejected, or Deleted.

Type: String

Valid Values: Verified | Pending | Deleted | Rejected

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The exception when the input is creating conflict with the given state.

HTTP Status Code: 409

InternalServerException

The exception thrown when an unexpected error occurs when processing a request.

HTTP Status Code: 500

ValidationException

The exception when the input doesn't pass validation for at least one of the input parameters.

HTTP Status Code: 400