Tax Payer
This endpoint retrieves the taxpayer's details associated with a specific merchant. It provides detailed information such as the taxpayer's Legal First Name, Legal Last Name, TIN Type ID, and other relevant attributes stored in the database. The endpoint also supports an optional parameter, encryptedTin
, which can be set to true
if encrypted TIN values are required in the response. Clients using this endpoint should ensure they have the necessary entitlements and pass a valid merchant number in the request. This is critical for retrieving taxpayer information securely and accurately.
Merchant number used to get tax payer details.
false
Correlation Id for the request
GET /api/demographics/v2/Taxpayers/{merchantNumber} HTTP/1.1
Host: localhost:5000
Accept: */*
{
"legalFirstName": "John",
"legalLastName": "Doe",
"tin": "123456789",
"encryptedTIN": "[****3433, ****4485]",
"tinLastFour": "4673",
"tinTypeID": 2,
"businessLegalName": "Acme Corporation",
"stateIncorporatedCode": "CA"
}
This endpoint allows to update a taxpayer's details associated with a specific merchant, identified by the merchantNumber
.
The request body contains the taxpayer's details, including fields such as legalFirstName
, legalLastName
, tinTypeId
, and other relevant attributes. Clients should ensure that all required fields in the request body are properly filled and valid before making the request. The endpoint supports an optional encryptedTin
parameter, which, when set to true
, ensures that TIN values are stored and transmitted in an encrypted format for added security.
Merchant number used to update the tax payer's details.
false
Correlation Id for the request
First name of the tax payer.
John
Last name of the tax payer.
Doe
Taxpayer Identification Number (TIN). Must be exactly 9 characters long.
123456789
Encrypted representation of the TIN for security purposes.
[****3433, ****4485]
Represents last fout digits of TIN number
4673
Identifier for the type of TIN. Must be between 1 and 3.
2
The legal name of the business associated with the taxpayer.
Acme Corporation
The state where the business is incorporated. Represented as a two-character code.
CA
PUT /api/demographics/v2/Taxpayers/{merchantNumber} HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 185
{
"legalFirstName": "John",
"legalLastName": "Doe",
"tin": "123456789",
"encryptedTIN": "[****3433, ****4485]",
"tinTypeID": 2,
"businessLegalName": "Acme Corporation",
"stateIncorporatedCode": "CA"
}
{
"legalFirstName": "John",
"legalLastName": "Doe",
"tin": "123456789",
"encryptedTIN": "[****3433, ****4485]",
"tinLastFour": "4673",
"tinTypeID": 2,
"businessLegalName": "Acme Corporation",
"stateIncorporatedCode": "CA"
}
Was this helpful?