Get

Get

This endpoint retrieves the complete details of a specific recipient — including name, TIN information, address, contact details, and any form-specific fields. Use this to verify recipient data or retrieve details for display in your application.

You can provide any one of the following identifier combinations to retrieve the recipient details

• RecipientId only
• PayeeRef only
• TINType with TIN
• TINType with Encrypted TIN
• TINType with TIN Token
• TINType with the last 4 digits of the TIN

GET recipient/get

Run in Postman

Request Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient. Required if PayeeRef is not provided.
PayeeRef	String	Optional Your unique identifier for the recipient. Required if RecipientId is not provided.
TINType	String	The TIN type of the recipient. Allowed values "EIN", "SSN", "QI-EIN", "ITIN", "WP-EIN", "WT-EIN", "NQI-EIN", "IRSN"
TIN	String	Taxpayer Identification Number of the recipient.
EncryptedTIN	String	Encrypted Taxpayer Identification Number of the recipient.
TINToken	String	Tokenized Taxpayer Identification Number of the recipient.
Last4Digit	String	Last 4 digits of the Taxpayer Identification Number of the recipient.
DBAId	GUID	TaxBandits-generated unique identifier for a specific DBA to retrieve.
DBARef	String	Your unique identifier for a specific DBA to retrieve.

Response Body

Field	Type	Description
Recipient	Object []	Array of matching recipient records.
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRefs	String []	Your unique identifier(s) for the payee.
IsActive	Boolean	Identifies whether this recipient is currently active.
TINDetails	Object	TIN details of the recipient.
TINType	String	TIN type of the recipient.
TIN	String	Taxpayer identification number of the recipient.
TINToken	String	Tokenized TIN of the recipient.
EncryptedTIN	String	Encrypted TIN of the recipient.
Last4Digit	String	Last 4 digits of the recipient TIN.
TINMatchStatus	String	TIN matching status of the recipient.
IndividualNm	Object	If the TINType is SSN, ITIN, or ATIN.
FirstNm	String	First name of the individual.
MiddleNm	String	Middle name of the individual.
LastNm	String	Last name of the individual.
Suffix	String	Suffix of the individual's name.
BusinessNm	String	Name of the recipient business.
DBADetails	Object []	DBA details of the recipient.
DBANm	String	Name of the DBA.
DBARef	String	Your unique identifier for the DBA.
DBAId	GUID	TaxBandits-generated unique identifier for the DBA.
Address	Object	Address details of the DBA.
Address1	String	Street address or PO Box of the DBA.
Address2	String	Suite or apartment of the DBA.
City	String	City of the DBA.
ProvinceOrState	String	Province or state name of the DBA.
ZipCd	String	ZIP code of the DBA.
Country	String	Country code of the DBA.
Address	Object	Address of the recipient.
Address1	String	Street address or PO Box of the recipient.
Address2	String	Suite or apartment of the recipient.
City	String	City of the recipient.
ProvinceOrState	String	Province or state name of the recipient.
ZipCd	String	ZIP code of the recipient.
Country	String	Country code of the recipient.
DOB	String	Date of Birth of the recipient.
Email	String	Email address of the recipient.
Fax	String	Fax number of the recipient.
Phone	String	Phone number of the recipient.
W9Details	Object	Information specific to W-9 / 1099 recipients.
FedTaxClassification	String	Federal tax classification of the recipient.
ExemptPayeeCd	String	Exempt payee code reported on Form W-9.
FATCACode	String	Exemption from FATCA reporting code.
IsBackupWth	Boolean	Indicates whether the recipient is subject to backup withholding.
W8BenDetails	Object	Information specific to foreign recipients (Form W-8BEN).
CitizenOfCountry	String	Country of citizenship of the recipient.
FTIN	String	Foreign Tax Identification Number of the recipient.
IsFTINNotLegallyRequired	Boolean	Indicates whether the recipient is not legally required to provide an FTIN.
1042SDetails	Object	Information specific to 1042-S filings.
Ch3Cd	String	Chapter 3 status code of the recipient.
Ch4Cd	String	Chapter 4 status code of the recipient.
GIIN	String	Recipient's Global Intermediary Identification Number (GIIN).
LOBCode	String	Limitation on Benefits (LOB) code claimed by the recipient.
Errors	Object []	Top-level request errors if the entire request cannot be processed.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of what went wrong.

Request JSON

recipient/get?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&tintype=SSN&last4digit=6000&payeeref=PAYEE001&DBARef=SC001&dbaid=a32b351f-00b6-4639-a1ec-835b10ee8dae

Response JSON

{
    "Recipients": [
        {
            "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
            "PayeeRefs": [
                "PAYEE001"
            ],
            "IsActive": true,
            "TINDetails": {
                "Format": "PLAIN_TIN",
                "TINType": "SSN",
                "TIN": "123-45-6000",
    
            },
            "IndividualNm": {
                "FirstNm": "John",
                "MiddleNm": "Michael",
                "LastNm": "Smith",
                "Suffix": null,
            },
            "NameCtrl": null,
            "BusinessNm": null,
            "DBADetails": [
                {
                    "DBANm": "Smith Consulting",
                    "DBARef": "SC001",
                    "DBAId": "a32b351f-00b6-4639-a1ec-835b10ee8dae",
                    "Address": {
                        "Address1": "4500 N Lamar Blvd",
                        "Address2": "Suite 210",
                        "City": "Austin",
                        "ProvinceOrState": "TX",
                        "ZipCd": "78756",
                        "Country": "US"
                    }
                }
            ],
            "Address": {
                "Address1": "123 Main Street",
                "Address2": "Apt 4B",
                "City": "Austin",
                "ProvinceOrState": "TX",
                "ZipCd": "78701",
                "Country": "US"
            },
            "DOB": "01/05/1970",
            "Email": "john.smith@example.com",
            "Fax": null,
            "Phone": "(512) 555-1234",
            "W9Details": {
                "FedTaxClassification": "INDIVIDUAL_OR_SOLE_PROPRIETOR",
                "ExemptPayeeCd": null,
                "FATCACode": null,
                "IsBackupWth": false
            },
            "W8BenDetails": null,
            "Form1042SDetails": null
        }
    ],
    "Errors": null
}