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

GetTaxRegistration

Retrieves tax registration for a single account.

Request Syntax


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

{
   "accountId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountId

Your unique account identifier.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "taxRegistration": { 
      "additionalTaxInformation": { 
         "brazilAdditionalInfo": { 
            "ccmCode": "string",
            "legalNatureCode": "string"
         },
         "canadaAdditionalInfo": { 
            "canadaQuebecSalesTaxNumber": "string",
            "canadaRetailSalesTaxNumber": "string",
            "isResellerAccount": boolean,
            "provincialSalesTaxId": "string"
         },
         "estoniaAdditionalInfo": { 
            "registryCommercialCode": "string"
         },
         "georgiaAdditionalInfo": { 
            "personType": "string"
         },
         "indiaAdditionalInfo": { 
            "pan": "string"
         },
         "israelAdditionalInfo": { 
            "customerType": "string",
            "dealerType": "string"
         },
         "italyAdditionalInfo": { 
            "cigNumber": "string",
            "cupNumber": "string",
            "sdiAccountId": "string",
            "taxCode": "string"
         },
         "kenyaAdditionalInfo": { 
            "personType": "string"
         },
         "malaysiaAdditionalInfo": { 
            "businessRegistrationNumber": "string",
            "serviceTaxCodes": [ "string" ],
            "taxInformationNumber": "string"
         },
         "polandAdditionalInfo": { 
            "individualRegistrationNumber": "string",
            "isGroupVatEnabled": boolean
         },
         "romaniaAdditionalInfo": { 
            "taxRegistrationNumberType": "string"
         },
         "saudiArabiaAdditionalInfo": { 
            "taxRegistrationNumberType": "string"
         },
         "southKoreaAdditionalInfo": { 
            "businessRepresentativeName": "string",
            "itemOfBusiness": "string",
            "lineOfBusiness": "string"
         },
         "spainAdditionalInfo": { 
            "registrationType": "string"
         },
         "turkeyAdditionalInfo": { 
            "industries": "string",
            "kepEmailId": "string",
            "secondaryTaxId": "string",
            "taxOffice": "string"
         },
         "ukraineAdditionalInfo": { 
            "ukraineTrnType": "string"
         }
      },
      "certifiedEmailId": "string",
      "legalAddress": { 
         "addressLine1": "string",
         "addressLine2": "string",
         "addressLine3": "string",
         "city": "string",
         "countryCode": "string",
         "districtOrCounty": "string",
         "postalCode": "string",
         "stateOrRegion": "string"
      },
      "legalName": "string",
      "registrationId": "string",
      "registrationType": "string",
      "sector": "string",
      "status": "string",
      "taxDocumentMetadatas": [ 
         { 
            "taxDocumentAccessToken": "string",
            "taxDocumentName": "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.

taxRegistration

TRN information of the account mentioned in the request.

Type: TaxRegistration object

Errors

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The exception thrown when the input doesn't have a resource associated to it.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400