Get

Use this endpoint to obtain the details of a created recipient, such as the name, address, and contact details. In the request JSON, you must provide the RecipientId along with the BusinessId.

GET Recipient/Get

Request Params

Field	Type	Description
BusinessId	Guid	Unique identifier of a business.
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.

Response Body

Field	Type	Description
Business	object	Object to identify the Business Details.
BusinessId	Guid	Returns the unique Business ID for the Business. It can be used in the future to refer to the same business.
BusinessNm	string	Name of the business. Size Range: ..75
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 Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
TINType	string	Specify the TIN type of the business. Allowed values "SSN", "EIN"
TIN	string	Enter the nine-digit taxpayer identification number of the business (SSN,EIN). Size Range: 9
PayerRef	string	A unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	A unique identifier generated by TaxBandits for a Recipient. You can use this ID for your future reference to Update.
TINType	string	Specify the TIN type of the recipient. Allowed values "SSN", "EIN", "ITIN", "ATIN", "NA"
TIN	string	Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9
FirstPayeeNm	string	Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 40
SecondPayeeNm	string	Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field. Size Range: 40
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 Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
PayeeRef	string	Optional A unique identifier for each payee completing their information. This identifier can be used in future references of the payee in the API. Size Range: 50
IsForeign	Boolean	When true, identifies the recipient address with a foreign address.
USAddress	object	If IsForeign is false, pass the US address of the recipient
Address1	string	Recipient's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Optional Recipient's suite or apartment Size Range: ..46
City	string	Recipient's city Size Range: ..50
State	string	Recipient's state code. Refer Static values. Size Range: 2 Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
ZipCd	string	Recipient's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass the foreign address of the recipient.
Address1	string	Recipient's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Optional Recipient's suite or apartment Size Range: ..50
City	string	Recipient's city. Size Range: ..50
ProvinceOrStateNm	string	Recipient's Province or State Name. Size Range: ..50
Country	string	Recipient's country code. Refer Static values. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd	string	Recipient's Postal Code. Size Range: ..16
Email	string	Optional Recipient's email address. Size Range: 0..100
Fax	string	Optional Recipient's Fax number. Size Range: 10
Phone	string	Optional Recipient's Phone Number. Size Range: 10
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Request Params

Recipient/get?BusinessId=ce18d2d0-6bf7-4a4f-a6e8-4fffccbb96a1&RecipientId=b3336932-89b9-44f5-9b7e-d32956fd70ba

Response Json

Response	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when your API requests contain any validation errors.

Response: 200

{
    "Business": {
        "BusinessId": "6d0bbbd5-fe4f-4c56-85c5-56f2ee759629",
        "BusinessNm": "Snowdaze LLC",
        "FirstNm": null,
        "LastNm": null,
        "MiddleNm": null,
        "Suffix": null,
        "PayerRef": "Snow123",
        "TINType": "SSN",
        "TIN": "003-31-3330"
    },
    "Recipient": {
        "RecipientId": "e235e37b-5807-48c5-bb39-d0dc01baa559",
        "TINType": "SSN",
        "TIN": "327-55-9984",
        "PayeeRef": null,
        "FirstPayeeNm": null,
        "SecondPayeeNm": null,
        "FirstNm": "Shawn",
        "LastNm": "Williams",
        "MiddleNm": "B",
        "Suffix": "IV",
        "IsForeign": true,
        "USAddress": null,
        "ForeignAddress": {
            "Address1": "120 Bremner Blvd",
            "Address2": "Suite 800",
            "City": "Toronto",
            "ProvinceOrStateNm": "Ontario",
            "Country": "IN",
            "PostalCd": "4168682600"
        },
        "Email": "shawn@sample.com",
        "Fax": "(663) 456-7890",
        "Phone": "(963) 456-7890"
    },
    "Errors": null
}

Node.js

Python

Java

.NET C#