ValidateForm
Validates the Forms in the request against IRS Business rules and field specification without creating the returns in TaxBandits.
POST Form1099R/ValidateForm
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides the brief information about a particular submission on the whole. It contains information like Submission ID, Tax Year, IsPostal, IsFederalFiling, IsStateFiling, IsOnlineAccess, IsScheduleFiling & ScheduleFiling service details. |
TaxYear | string | Tax year of Form 1099-R to be filed.. Allowed values: "2021" |
IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1099-R will be sent directly to the IRS. |
IsStateFiling | Boolean | State Filing for the return will be enabled when the value is True. Form 1099-R will be directly filed with the respective recipient states. Note: State Filing will not be created for the states that do not require State filing. |
IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 1099-R Recipient copies will be postal mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the Recipient. The recipient can provide consent and download Form 1099-R Recipient copies from the portal. |
IsScheduleFiling | Boolean | When true, schedule filing services will be provided for Form 1099-R returns under this submission. |
ScheduleFiling | object | Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True . |
EfileDate | string | Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 10/20/2021 or 10-20-2021 |
ReturnHeader | object | Contains information about the Business details. |
Business | object | Object to identify the Business Details. |
BusinessId | Guid | Optional Use the unique Business Id (Generated by TaxBandits) you received in response to the Business CREATE Endpoint. By giving the Business Id, you do not have to provide all the business information again. If you do not have a Business Id, ignore the field. |
BusinessNm | string | Name of the business Size Range: ..80 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
PayerRef | string | Optional An 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 |
TradeNm | string | Optional Name under which the business operates Size Range: ..80 |
IsEIN | Boolean | When true, identify that the business TIN is an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9-11 |
string | Optional Email address of the Business Size Range: ..100 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS. Size Range: ..27 |
Phone | string | Optional Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone number Size Range: ..5 |
Fax | string | Optional Fax number of the Business Size Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values"ESTE", "PART", "CORP", "EORG", "SPRO" |
SigningAuthority | object | Optional Details of the person who is authorized to sign the return |
Name | string | Optional Name of the signing authority Size Range: ..35 |
Phone | string | Optional Phone number of the signing authority Size Range: 10 |
BusinessMemberType | string | Optional Business title of the signing authority Size Range: 5..29 Allowed values"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER" |
KindOfEmployer | string | Optional Identifies the kind of employer. Mandatory for W-2 and optional for 1099-R and 94X seriesAllowed values"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-R and 94X seriesAllowed values"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
IsBusinessTerminated | Boolean | When true, identifies the business as terminated. |
IsForeign | Boolean | When true, identifies the business address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the business |
Address1 | string | Employer/Payer's US address (street or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..46 |
City | string | Employer/Payer's city Size Range: ..50 |
State | string | Employer/Payer'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 | Employer/Payer's zip code. Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the business |
Address1 | string | Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Employer/Payer's suite or apartment Size Range: ..50 |
City | string | Employer/Payer's city Size Range: ..50 |
ProvinceOrStateNm | string | Employer/Payer's province or state name Size Range: ..30 |
Country | string | Employer/Payer's country 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 | Employer/Payer's postal code Size Range: 9 |
ReturnData | object[] | Contains information about the recipient details and Form 1099-R details. |
SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50 |
Recipient | object | Object to identify the recipient details. |
RecipientId | Guid | Optional TaxBandits generates a unique ID for each recipient after the return is created and returned in the Response. You can use this id for your future reference to update. |
TINType | string | Specify the TIN type of the recipient. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. 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-11 |
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 Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
IsForeign | Boolean | When true, it identifies the recipient's address with a foreign address. |
USAddress | object | If IsForeign is false, pass 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 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 |
string | Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business. | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
RFormData | object | Recipient's Form 1099-R information. |
B1GrossDistribution | number | Gross Distribution - Get at least one distribution code. Size Range: 0-9999999999.99 |
B2aTaxableAmt | number | Taxable Amount - Gets the Taxable Amount Size Range: 0-9999999999.99 |
B2bIsTaxableAmtNotDetermined | Boolean | When True, the taxable amount of the payment entered for Gross distribution cannot be computed. |
B2bISTotalDistribution | Boolean | When True, the payment shown in gross Distribution Amount is a total distribution that closes out the account. |
B3CapitalGain | number | Capital Gain - Get the amount from a charitable gift annuity that is taxable as a capital gain. Size Range: 0-9999999999.99 |
B4FedTaxWH | number | Federal Tax Withheld - Get any federal income tax withheld. Size Range: 0-9999999999.99 Note : This value should be less than the 40% sum of boxes 1, 2a, 3, 5, 6, 8, 9b and 10. |
B5EmpContribution | number | Get the employee's contributions, designated Roth contributions, or insurance premiums that the employee may recover tax free this year. Size Range: 0-9999999999.99 |
B6NUA | number | Get all the NUA in employer securities if this is a lump-sum distribution. If this is not a lump-sum distribution, get only the NUA in employer securities attributable to employee contributions. Size Range: 0-9999999999.99 |
B7DistCodes | string | Get the appropriate code. More than one code may apply. Size Range: 2 Allowed values"1", " 18", "1B", " 1D", "1K", "1L", "1M", "1P", "2", "28", "2B", "2D", "2K", "2L", "2M", "2P", "3", "3D", "4", "48", "4A", "4B", "4D", "4G", "4H", "4K", "4L", "4M", "4P", "5", "6", "6W", "7", "7A", "7B", "7D", "7K", "7L", "7M", "8", " 81", "82", "84", "8B", "8J", "8K", "9", "A4", "A7", "B", "B1", "B2", "B4", "B7", "B8", "BG", "BL", "BM", "BP", "BU", "C", "CD", "D1", "D2", "D3", "D4", "D7", "DC", "E", "F", "G", "G4", "GB", "GK", "H", "H4", "J", "J8", "JP", "K1", "K2", "K4", "K7", "K8", "KG", "L", "L1", "L2", "L4", "L7", "LB", "M", "M1", "M2", "M4", "M7", "MB", "N", "P", "P1", "P2", "P4", "PB", "PJ", "Q", "R", "S", "T", "U", "UB", "W", "W6" |
B7IsSIRASEPSIMPLE | Boolean | When True, it is a traditional IRA, SEP, or SIMPLE distribution or Roth conversion. |
B8Other | number | Get the current actuarial value of an annuity contract that is part of a lump-sum distribution. Size Range: 0-9999999999.99 |
B8OtherPercentage | number | Get the percentage of the total annuity contract. |
B9aTotDistPercentage | number | Total Distribution Percentage - Get the percentage when reporting a total distribution to more than one person, such as when a participant is deceased, and an issuer distributes to two or more beneficiaries.If the percentage is 100, leave this field blank. Size Range: 2 |
B9bTotEmpContribution | number | Total employee contributions - Get the total employee Distribution. Do not include any amounts recovered tax free in prior years. Size Range: 0-9999999999.99 |
B10AmtToIRR5Years | number | Get the amount of the distribution allocable to an IRR made within the 5 year, beginning with the first day of the year in which the rollover was made. Size Range: 0-9999999999.99 |
B11DesigRoth1stYear | number | Get the first year of the 5 tax-year periods. This is the year in which the recipient first established the designated Roth account.It should be in "YYYY" Format. Size Range: 4 |
B12IsFATCAFiling | Boolean | When true, there is a FATCA Filing Requirement. |
B13DateOfPayment | string | Get the date of payment for reportable death benefits under section 6050Y.It should be in "YYYYMMDD" format. Size Range: 8 |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 1099-R is filed. Size Range: 4..20 |
States | object[] | Contains list of state returns information. |
StateCd | string | State Code. 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" |
StateIdNum | string | Identification Number of State. Size Range: ..20 |
StateWH | number | Income tax amount withheld for State. Size Range: 0-9999999999.99 |
StateDistribution | number | Total state distribution amount. Size Range: 0-9999999999.99 |
LocalDistribution | number | Local Distribution. Size Range: 0-9999999999.99 |
LocalTax | number | Local income tax withheld. Size Range: 0-9999999999.99 |
LocalityNm | string | Name of the Locality. Size Range: 20 |
Request JSON
{
"SubmissionManifest": {
"SubmissionId": null,
"TaxYear": "2021",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true,
"IsScheduleFiling": false,
"ScheduleFiling": null
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "RN123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "62-2269245",
"Email": "chandler@sample.com",
"ContactNm": "Chandler White",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Chandler White",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": true,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": [
{
"SequenceId": "1",
"IsPostal": true,
"IsOnlineAccess": true,
"Recipient": {
"RecipientId": null,
"TINType": "EIN",
"TIN": "563817572",
"FirstPayeeNm": "Stephen",
"SecondPayeeNm": "Davis",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"Email": "mark@sample.com",
"Fax": "1234567890",
"Phone": "1234567890"
},
"RFormData": {
"B1GrossDistribution": "2563",
"B2aTaxableAmt": 0,
"B2bIsTaxableAmtNotDetermined": true,
"B2bIsTotalDistribution": false,
"B3CapitalGain": 880,
"B4FedTaxWH": 90,
"B5EmpContribution": 0,
"B6NUA": 0,
"B7DistCodes": "1",
"B7IsSIRASEPSIMPLE": false,
"B8Other": 80,
"B8OtherPercentage": 99,
"B9aTotDistPercentage": 99,
"B9bTotEmpContribution": 0,
"B10AmtToIRR5Years": 0,
"B11DesigRoth1stYear": 1901,
"B12IsFATCAFiling": false,
"B13DateOfPayment": "12/3/2020",
"AccountNum": "9252",
"States": [
{
"StateCd": "PA",
"StateWH": 15.56,
"StateDistribution": 100,
"StateIdNum": "99999999",
"LocalDistribution": 300.23,
"LocalTax": 100.45,
"LocalityNm": "Pristine"
},
{
"StateCd": "AZ",
"StateWH": 17.45,
"StateDistribution": 100,
"StateIdNum": "99-9999999",
"LocalDistribution": 300.23,
"LocalTax": 100.45,
"LocalityNm": "Pristine"
}
]
}
}
]
}
Response Body
Field | Type | Description |
---|---|---|
StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
StatusName | string | Name of the status code |
StatusMessage | string | Detailed status message |
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 |
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"ErrorRecords": null,
"Errors": null
}