Learn about the /documents
endpoint.
The document object contains information from payroll documents that are retrieved and processed by Argyle after a user connects a payroll account. The contents of each specific document can be found in the document object's metadata.
Attributes
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
id | string uuid | Unique ID of the document associated with a user's payroll account. |
account | string uuid | ID of the payroll account associated with the document. |
employer | string | The name of the company or entity that employs the user. |
document_number | string | The identification number on the document. |
document_type | string | Describes the document type. Possible values: W-2 , payout-statement , W-4 , W-9 , 1099 , 1095 , profile-picture , drivers-licence , vehicle-insurance , vehicle-registration , vehicle-inspection , other . |
document_type_description | string | A free-form text describing the document's type—for example, W-2 Form 2019. |
expiration_date | string | The expiration date of the document. Timestamps follow the ISO 8601 standard. |
available_date | string | Represents the timestamp when the document was made available to the employee. |
file_url | string | If available, file_url contains a direct link to the file. This link is valid for 15 minutes. When it expires, you can call the documents endpoint again to generate another valid URL. |
metadata | object | Metadata holds additional available, often unstructured, information about this data resource. |
metadata.ocr_data | object optional | The ocr_data object describes the contents of the document retrieved through a connected payroll account and scanned by Argyle.Use the /forms endpoint for uploaded documents.More information about fields within the ocr_data object can be found in the metadata section below.The object will be null if the document was not scanned and its data was not extracted. |
created_at | string timestamp | Time at which the document object was created. Timestamps follow the ISO 8601 standard. |
updated_at | string timestamp | Time at which the document object was last updated. Timestamps follow the ISO 8601 standard. |
Metadata
metadata.ocr_data
attributes reference
General attributes
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
form_type | string optional | The type of form that was processed. Possible values: W-2 , W-2c , 1099-NEC , 1099-SSA , 1099-MISC , 1099-INT , 1099-R , 1099-G , 1099-K . |
omb_no | string optional | The OMB form and information collection number of the specific form type that was processed. |
year | string optional | The calendar year for which the form is valid. |
recipient.name | string optional | The employee’s legal name. All form types contain this field. |
recipient.address | object | Contains the employee’s address. All form types contain this field. Data fields within the recipient.address object:- address.city - address.country - address.line1 - address.line2 - address.postal_code - address.state |
recipient_tin | string optional | The employee’s Taxpayer Identification Number. All form types contain this field. |
payer.name | string optional | The employer’s name. All form types contain this field, except for 1099-SSA . |
payer.address | object | Contains the employer’s address. All form types contain this field, except for 1099-SSA .Data fields within the payer.address object:- address.city - address.country - address.line1 - address.line2 - address.postal_code - address.state |
payer_tin | string optional | The employer's Taxpayer Identification Number. All form types contain this field, except for 1099-SSA . |
{
"form_type": "1099-NEC",
"omb_no": "1545-0116",
"year": "2020",
"form": {
"recipient": {
"name": "John Smith",
"address": {
"city": "Norton",
"country": null,
"line1": "4321 S. Jackson St Apt 987C",
"line2": null,
"postal_code": "45678",
"state": "MA"
}
},
"recipient_tin": "***-**-0193",
"payer": {
"name": "Peak Performance Publishing LLC",
"address": {
"city": "Ambler",
"country": null,
"line1": "118 Mary Ambler Way",
"line2": null,
"postal_code": "19002",
"state": "PA"
}
},
"payer_tin": "46-5237939"
}
}
Quality attributes
The ocr_data
object provides details on the success of data retrieval from payroll documents processed by Argyle after a user connects a payroll account. Whenever the process encounters an issue, it raises a warning. Some of these warnings may be errors, others are just information about a missing field in the document.
The type of the warning is detailed in the
warnings.message
field and determines the severity of that warning.warnings.severity
indicates whether a warning is considered anerror
or not. Based on the number of errors raised during the process, the estimated level of parsing success will be included in theconfidence
field.
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
warnings | array of objects | This array of objects contains the list of warnings for fields where warnings were raised. |
warnings.field_name | string optional | Indicates the name of the field where a warning was raised. |
warnings.message | string optional | Includes the field_name and the type of warning that affects the field.Possible warning messages are listed below in this table. |
warnings.severity | string optional | Indicates whether a warning is considered an error or not. - ERROR is shown as 1.0 . For example, a not found warning is considered an error.- NOT ERROR is shown as 0.0 . For example, a value empty/bad format , or an obfuscated warning are not considered errors.- UNKNOWN is shown as 0.5 . UNKNOWN is used when a field or its value is not found, but it is not clear whether the information should be present in the document. |
confidence | string optional | Indicates an estimated level of parsing success, based on the number of errors found. - EXACT_MATCH - No error was found.- HIGH - 1 error was found.- MEDIUM - 2 errors were found.- LOW - 3 errors were found.- NO_MATCH - 4 or more errors were found, which usually means that the document is the wrong type. |
warnings.message
warnings.message
WARNING MESSAGE | FIELDS | DESCRIPTION |
---|---|---|
not found | Any | The field was not found within the document. |
value empty/bad format | Any | The field was found, but the value was empty, or misread, or in an incorrect format. |
obfuscated | recipient_tin | Taxpayer Identification Number is completely obfuscated. |
obfuscated last two digits given | recipient_tin | Only last two digits of Taxpayer Identification Number are visible. |
obfuscated last four digits given | recipient_tin | Only last four digits of Taxpayer Identification Number are visible. |
field_name had non numeric chars removed, original value: <value> | Fields with strictly numeric values. | If numeric validation fails, removal of non-numeric characters is attempted. This warning is issued when the invalid characters from the numeric field are successfully filtered. |
field_name invalid - non numeric value, original value: <value> | Fields with strictly numeric values. | If numeric validation fails, removal of non-numeric characters is attempted. This warning is issued when the invalid characters from the numeric field could not be filtered. |
{
"warnings": [
{
"field_name": "recipient_tin",
"message": "recipient_tin obfuscated, 2 last digits given",
"severity": 0.0
},
{
"field_name": "benefits_3",
"message": "benefits_3 had non numeric chars removed, original value: *1507.40",
"severity": 0.0
},
{
"field_name": "state_inc_7",
"message": "state_inc_7 value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH"
}
Metadata error
ATTRIBUTE | TYPE | DESCRIPTION |
---|---|---|
error | string optional | When the document data retrieval process fails, error field will return the specific type of error that happened.- invalid_document - The document is not valid. It could be incomplete, cropped incorrectly and missing the required fields, or not filled at all.- unknown - An internal issue occurred during document processing. Argyle is investigating. |
{
"ocr_data": {
"error": "invalid_document"
}
}
metadata.ocr_data
attributes specific to document_type
W-2 and 1099
W-2 and 1099 attributes
Argyle extracts and standardizes data from the following supported document types when retrieving payroll documents after a user connects a payroll account.
W-2 and W-2c (Wage and Tax Statement, Corrected Wage and Tax Statement)
Field name | Description |
---|---|
control_no_d | The code that uniquely identifies a particular W-2 document in the employer's records. |
comp_1 | The amount of wages, tips, and other compensation. |
fed_income_tax_2 | The amount of federal income tax withheld. |
ss_wages_3 | The amount of social security wages. |
ss_tax_4 | The amount of social security tax withheld. |
med_wages_5 | The amount of Medicare wages and tips. |
med_tax_6 | The amount of Medicare tax withheld. |
ss_tips_7 | The amount of social security tips. |
tips_8 | The amount of allocated tips. |
verification_9 | A code used to verify the accuracy of the form’s contents during electronic tax return. |
benefits_10 | The amount of dependent care benefits. |
nonqualified_11 | The amount of contributions made to a nonqualified savings plan. |
uncollected_ss_RRTA_12a | The amount of uncollected social security or RRTA tax on tips. |
uncollected_med_tax_12b | The amount of uncollected Medicare tax on tips. |
insurance_12c | The amount of taxable cos of group-term life insurance over $50,000. |
plan_401k_12d | The amount of elective deferrals related to contributions to 401-k plan. |
other_14 | Used to report additional tax information. |
employers_state_15 | Lists the state for which the employer withheld the taxes, and to which the employer remitted the taxes. Indicates the employer’s state ID number. |
state_wages_16 | The amount of state wages, tips, etc. |
state_income_tax_17 | The amount of state income tax. |
local_wages_18 | The amount of local wages, tips, etc. |
local_income_tax_19 | The amount of local income tax. |
locality_name_20 | The name of the locality where taxes indicated in the local_income_tax_19 field are paid. |
Example W-2 object
{
"form_type": "W-2",
"omb_no": null,
"year": "2019",
"form": {
"recipient": {
"name": "John Smith",
"address": {
"city": "Norton",
"country": null,
"line1": "4 Jackson St",
"line2": null,
"postal_code": "75211",
"state": "MA"
}
},
"recipient_tin": "123-12-1234",
"payer": {
"name": "EAST COAST ASSEMBLERS INC",
"address": {
"city": "Lake Worth",
"country": null,
"line1": "6586 Hypolouxo Road",
"line2": "Suite 145",
"postal_code": "33467",
"state": "FL"
}
},
"payer_tin": "20-0388460",
"control_no_d": "86O78 6805",
"comp_1": "1540.83",
"fed_income_tax_2": "147.41",
"ss_wages_3": "1540.83",
"ss_tax_4": "95.53",
"med_wages_5": "1540.83",
"med_tax_6": "22.34",
"ss_tips_7": null,
"tips_8": null,
"verification_9": null,
"benefits_10": null,
"nonqualified_11": null,
"uncollected_ss_RRTA_12a": null,
"uncollected_med_tax_12b": null,
"insurance_12c": null,
"plan_401k_12d": null,
"other_14": null,
"employers_state_15": null,
"state_wages_16": null,
"state_income_tax_17": null,
"local_wages_18": "N/A",
"local_income_tax_19": "N/A",
"locality_name_20": "N/A"
},
"warnings": [
{
"field_name": "ss_tips_7",
"message": "ss_tips_7 value empty/bad format",
"severity": 0.0
},
{
"field_name": "tips_8",
"message": "tips_8 value empty/bad format",
"severity": 0.0
},
{
"field_name": "benefits_10",
"message": "benefits_10 value empty/bad format",
"severity": 0.0
},
{
"field_name": "nonqualified_11",
"message": "nonqualified_11 value empty/bad format",
"severity": 0.0
},
{
"field_name": "uncollected_ss_RRTA_12a",
"message": "uncollected_ss_RRTA_12a value empty/bad format",
"severity": 0.0
},
{
"field_name": "uncollected_med_tax_12b",
"message": "uncollected_med_tax_12b value empty/bad format",
"severity": 0.0
},
{
"field_name": "insurance_12c",
"message": "insurance_12c value empty/bad format",
"severity": 0.0
},
{
"field_name": "plan_401k_12d",
"message": "plan_401k_12d value empty/bad format",
"severity": 0.0
},
{
"field_name": "employers_state_15",
"message": "employers_state_15 not found",
"severity": 0.0
},
{
"field_name": "state_wages_16",
"message": "state_wages_16 not found",
"severity": 0.0
},
{
"field_name": "state_income_tax_17",
"message": "state_income_tax_17 not found",
"severity": 0.0
},
{
"field_name": "other_14",
"message": "other_14 value empty/bad format",
"severity": 0.0
},
{
"field_name": "verification_9",
"message": "verification_9 value empty/bad format",
"severity": 0.0
},
{
"field_name": "omb_no",
"message": "omb_no not found",
"severity": 1.0
}
],
"confidence": "HIGH",
"ocr_page_count": 1
}
1099-NEC (Nonemployee Compensation)
Field name | Description |
---|---|
account_no | A code that is unique to the recipient and the form, for example a bank account number, employee ID, etc. |
comp_1 | The amount of nonemployee compensation. |
fed_inc_tax_4 | The amount of federal income tax withheld. |
state_tax_5 | The amount of state tax withheld. |
state_no_6 | The abbreviated name of the state and the payer’s state tax identification number. |
state_inc_7 | The amount of state income. |
Example 1099-NEC object
{
"form_type": "1099-NEC",
"omb_no": "1545-0116",
"year": "2020",
"form": {
"recipient": {
"name": "John Smith",
"address": {
"city": "Norton",
"country": null,
"line1": "4321 S. Jackson St Apt 987C",
"line2": null,
"postal_code": "45678",
"state": "MA"
}
},
"recipient_tin": "***-**-0193",
"payer": {
"name": "Peak Performance Publishing LLC",
"address": {
"city": "Ambler",
"country": null,
"line1": "118 Mary Ambler Way",
"line2": null,
"postal_code": "19002",
"state": "PA"
}
},
"payer_tin": "46-5237939",
"account_no": "zeno000046945",
"comp_1": "22796.50",
"fed_inc_tax_4": "0.00",
"state_tax_5": null,
"state_no_6": null,
"state_inc_7": null
},
"warnings": [
{
"field_name": "recipient_tin",
"message": "recipient_tin obfuscated",
"severity": 0.0
},
{
"field_name": "state_tax_5",
"message": "state_tax_5 value empty/bad format",
"severity": 0.0
},
{
"field_name": "state_no_6",
"message": "state_no_6 value empty/bad format",
"severity": 0.0
},
{
"field_name": "state_inc_7",
"message": "state_inc_7 value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-SSA (Social Security Benefits)
Field name | Description |
---|---|
recipient_name_1 | The name of the recipient. |
benefits_3 | The amount of benefits paid. |
benefits_ssa_4 | The amount of benefits repaid to SSA. |
net_benefits_5 | The amount of net benefits. |
fed_inc_tax_6 | The amount of voluntary federal income tax withholding. |
claim_no | The social security number under which a claim is filed or benefits are paid. |
Example 1099-SSA object
{
"form_type": "1099-SSA",
"omb_no": null,
"year": "2021",
"form": {
"recipient": {
"name": "JOHN SMITH"
},
"recipient_tin": "666-66-6666",
"recipient_name_1": "JOHN SMITH",
"benefits_3": "1507.40",
"benefits_ssa_4": "66.40",
"net_benefits_5": "1441.00",
"fed_inc_tax_6": "NONE",
"claim_no": "123-12-1234C2"
},
"warnings": [
{
"field_name": "omb_no",
"message": "omb_no not found",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-MISC (Miscellaneous Income)
Field name | Description |
---|---|
account_no | A code that is unique to the recipient and the form, for example a bank account number, employee ID, etc. |
rent_1 | The amount of rental income. |
royalties_2 | The amount of royalty income. |
other_inc_3 | Other income. |
fed_inc_4 | The amount of federal income tax withheld. |
fishing_5 | The amount of fishing boat proceeds. |
med_care_6 | The amount of medical and health care payment. |
comp_7 | The amount nonemployee compensation. |
crop_insurance_10 | The amount of crop insurance proceeds. |
golden_parachute_13 | The amount of excess Golden Parachute payments. |
gross_attorney_14 | The amount of gross proceeds paid to an attorney. |
sec_409a_defer_15a | The amount of section 409A deferrals. |
sec_409a_inc_15b | The amount of section 409A income. |
state_tax_16 | The amount of state tax withheld. |
state_no_17 | The abbreviated name of the state and the payer’s state tax identification number. |
state_inc | The amount of state income. |
Example 1099-MISC object
{
"form_type": "1099-MISC",
"omb_no": "1545-0115",
"year": "2018",
"form": {
"recipient": {
"name": "JOHN SMITH",
"address": {
"city": "Norton",
"country": null,
"line1": "888 W JACKSON ST APT #123",
"line2": null,
"postal_code": "54321",
"state": "MA"
}
},
"recipient_tin": "123-56-6789",
"payer": {
"name": "IPS INC",
"address": {
"city": "TUSTIN",
"country": null,
"line1": "3002 DOW AVE UNIT 512",
"line2": null,
"postal_code": "92780",
"state": "CA"
}
},
"payer_tin": "81-2570912",
"account_no": "000131losa/kqsa",
"rent_1": null,
"royalties_2": null,
"other_inc_3": null,
"fed_inc_4": null,
"fishing_5": null,
"med_care_6": null,
"comp_7": "2227.85",
"crop_insurance_10": null,
"sec_409a_defer_15a": null,
"sec_409a_inc_15b": null,
"state_tax_16": null,
"state_no_17": "CA066-5069 1",
"state_inc": null
},
"warnings": [
{
"field_name": "rent_1",
"message": "rent_1 value empty/bad format",
"severity": 0.0
},
{
"field_name": "royalties_2",
"message": "royalties_2 value empty/bad format",
"severity": 0.0
},
{
"field_name": "other_inc_3",
"message": "other_inc_3 value empty/bad format",
"severity": 0.0
},
{
"field_name": "fed_inc_4",
"message": "fed_inc_4 value empty/bad format",
"severity": 0.0
},
{
"field_name": "fishing_5",
"message": "fishing_5 value empty/bad format",
"severity": 0.0
},
{
"field_name": "med_care_6",
"message": "med_care_6 value empty/bad format",
"severity": 0.0
},
{
"field_name": "crop_insurance_10",
"message": "crop_insurance_10 value empty/bad format",
"severity": 0.0
},
{
"field_name": "sec_409a_defer_15a",
"message": "sec_409a_defer_15a value empty/bad format",
"severity": 0.0
},
{
"field_name": "sec_409a_inc_15b",
"message": "sec_409a_inc_15b value empty/bad format",
"severity": 0.0
},
{
"field_name": "state_tax_16",
"message": "state_tax_16 value empty/bad format",
"severity": 0.0
},
{
"field_name": "state_inc",
"message": "state_inc value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-INT (Interest Income)
Field name | Description |
---|---|
payer_rtn | The payer's RTN (Routing and Transit Number). |
account_no | A code that is unique to the recipient and the form, for example a bank account number, employee ID, etc. |
interest_1 | The amount of interest income. |
withdraw_penalty_2 | The amount of early withdrawal penalty. |
interest_obligations_3 | The amount of interest earned on U.S. savings bonds or Treasury notes, bills or bonds. |
fed_inc_tax_4 | The amount of federal income tax withheld. |
investment_5 | The amount of investment expenses. |
foreign_tax_6 | The amount of foreign tax paid. |
foreign_possession_7 | Shows the country or U.S. possession to which the foreign tax was paid. |
Example 1099-INT object
{
"form_type": "1099-INT",
"omb_no": "1545-0112",
"year": "2018",
"form": {
"recipient": {
"name": "JOHN SMITH",
"address": {
"city": "Norton",
"country": null,
"line1": "4 Jackson St",
"line2": null,
"postal_code": "27660",
"state": "MA"
}
},
"recipient_tin": "123-45-678",
"payer": {
"name": "DEFENSE FINANCE AND ACCTG SERVICE",
"address": {
"city": "Cleveland",
"country": null,
"line1": "1240 E 9TH ST",
"line2": null,
"postal_code": "44199-9904",
"state": "OH"
}
},
"payer_tin": "34-9990000",
"payer_rtn": null,
"account_no": "593901503",
"interest_1": "475.00",
"withdraw_penalty_2": null,
"interest_obligations_3": null,
"fed_inc_tax_4": null,
"investment_5": null,
"foreign_tax_6": null,
"foreign_possession_7": null
},
"warnings": [
{
"field_name": "payer_rtn",
"message": "payer_rtn value empty/bad format",
"severity": 0.0
},
{
"field_name": "withdraw_penalty_2",
"message": "withdraw_penalty_2 value empty/bad format",
"severity": 0.0
},
{
"field_name": "interest_obligations_3",
"message": "interest_obligations_3 value empty/bad format",
"severity": 0.0
},
{
"field_name": "fed_inc_tax_4",
"message": "fed_inc_tax_4 value empty/bad format",
"severity": 0.0
},
{
"field_name": "investment_5",
"message": "investment_5 value empty/bad format",
"severity": 0.0
},
{
"field_name": "foreign_tax_6",
"message": "foreign_tax_6 value empty/bad format",
"severity": 0.0
},
{
"field_name": "foreign_possession_7",
"message": "foreign_possession_7 value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-R (Distributions From Pensions, Annuities)
Field name | Description |
---|---|
control_no | The code that uniquely identifies a particular 1099-R document in the employer's records. |
gross_1 | The amount of gross distribution. |
tax_amount_2a | The amount of distribution that is taxable. |
fed_inc_tax_4 | The amount of federal income tax withheld. |
distribution_code_7 | A code that identifies the type of distribution received. |
distribution_percent_9 | The percentage of total distribution received. |
state_tax_14 | The amount of state tax withheld. |
state_no_15 | The abbreviated name of the state and the payer’s state tax identification number. |
Example 1099-R object
{
"form_type": "1099-R",
"omb_no": "1545-0119",
"year": "2019",
"form": {
"recipient": {
"name": "JOHN SMITH",
"address": {
"city": "NORTON",
"country": null,
"line1": "1480 JACKSON ST",
"line2": null,
"postal_code": "12345-1234",
"state": "MA"
}
},
"recipient_tin": "111223333",
"payer": {
"name": "Defense Finance and Accounting Service U.S. Military Retired Pay",
"address": {
"city": "Indianapolis",
"country": null,
"line1": "8899 E 56th Street",
"line2": null,
"postal_code": "46249-1200",
"state": "IN"
}
},
"payer_tin": "34-0727612",
"control_no": null,
"gross_1": "14978.94",
"tax_amount_2a": "14978.94",
"fed_inc_tax_4": "382.08",
"distribution_code_7": null,
"distribution_percent_9": null,
"state_tax_14": "300.00",
"state_no_15": "VA 987654321",
"retired": "01012019-12312019"
},
"warnings": [
{
"field_name": "control_no",
"message": "control_no value empty/bad format",
"severity": 0.0
},
{
"field_name": "distribution_code_7",
"message": "distribution_code_7 value empty/bad format",
"severity": 0.0
},
{
"field_name": "distribution_percent_9",
"message": "distribution_percent_9 value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-G (Certain Government Payments)
Field name | Description |
---|---|
a_unemployment_comp_1 | The amount of unemployment compensation. |
a_state_inc_tax_2 | The amount of state or local income tax refunds, credits or offsets. |
a_benefits_this_year_3 | The amount of benefits repaid for current year. |
a_benefits_prev_year_3 | The amount of benefits repaid for previous year. |
a_fed_inc_tax_4 | The amount of federal income tax withheld. |
b_unemployment_comp_1 | The amount of unemployment compensation, paid family leave. |
b_state_inc_tax_2 | The amount of state or local income tax refunds, credits or offsets. |
b_benefits_this_year_3 | The amount of benefits repaid for current year. |
b_benefits_prev_year_3 | The amount of benefits repaid for previous year. |
b_fed_inc_tax_4 | The amount of federal income tax withheld. |
Example 1099-G object
{
"form_type": "1099-G",
"omb_no": "1454-0120",
"year": "2020",
"form": {
"recipient": {
"name": "JOHN SMITH",
"address": {
"city": "Norton",
"country": null,
"line1": "4 Jackson Street",
"line2": "Po box 1234",
"postal_code": "92382-7434",
"state": "MA"
}
},
"recipient_tin": "***-**-1234",
"payer": {
"name": "Unemployment Insurance Integrity and Accounting Division",
"address": {
"city": "Rancho Cordova",
"country": null,
"line1": "P.O. Box 2408",
"line2": "MIC 16A",
"postal_code": "95741-2408",
"state": "CA"
}
},
"payer_tin": "94-2650401",
"a_unemployment_comp_1": "30900.00",
"a_state_inc_tax_2": "0.00",
"a_benefits_this_year_3": "0.00",
"a_benefits_prev_year_3": "0.00",
"a_fed_inc_tax_4": "90.00",
"b_unemployment_comp_1": "0.00",
"b_state_inc_tax_2": "0.00",
"b_benefits_this_year_3": "0.00",
"b_benefits_prev_year_3": "0.00",
"b_fed_inc_tax_4": "0.00"
},
"warnings": [
{
"field_name": "recipient_tin",
"message": "recipient_tin obfuscated",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
1099-K (Payment Card and Third Party Network Transactions)
Field name | Description |
---|---|
pse_name_phone | PSE's name and telephone number. |
account_no | A code that is unique to the recipient and the form, for example a bank account number, employee ID, etc. |
gross_1a | Gross amount of payment card/third party network transactions. |
gross_1b | The amount of Card Not Present transactions. |
category_code_2 | Merchant category code. |
no_transactions_3 | Number of payment transactions. |
fed_inc_tax_4 | The amount of federal income tax withheld. |
january_5a | The total reportable payment transactions for this month. |
february_5b | The total reportable payment transactions for this month. |
march_5c | The total reportable payment transactions for this month. |
april_5d | The total reportable payment transactions for this month. |
may_5e | The total reportable payment transactions for this month. |
june_5f | The total reportable payment transactions for this month. |
july_5g | The total reportable payment transactions for this month. |
august_5h | The total reportable payment transactions for this month. |
september_5i | The total reportable payment transactions for this month. |
october_5j | The total reportable payment transactions for this month. |
november_5k | The total reportable payment transactions for this month. |
december_5l | The total reportable payment transactions for this month. |
state_6 | State. |
state_id_7 | State identification number. |
state_income_8 | The amount of state income tax withheld. |
Example 1099-K object
{
"form_type": "1099-K",
"omb_no": "1545-2205",
"year": "2020",
"form": {
"recipient": {
"name": "JOHN SMITH",
"address": {
"city": "NORTON",
"country": null,
"line1": "4 E JACKSON STREET 2FL",
"line2": null,
"postal_code": "12345",
"state": "MA"
}
},
"recipient_tin": "***-**-2345",
"payer": {
"name": "LYFT, INC",
"address": {
"city": "SAN FRANCISCO",
"country": null,
"line1": "185 BERRY ST. SUITE 5000",
"line2": null,
"postal_code": "94107",
"state": "CA"
}
},
"payer_tin": "20-8809830",
"pse_name_phone": null,
"account_no": "10099240023921642.58",
"gross_1a": "28119.23",
"gross_1b": null,
"category_code_2": "41.21",
"no_transactions_3": null,
"fed_inc_tax_4": null,
"january_5a": "476.66",
"february_5b": "3052.06",
"march_5c": "2875.24",
"april_5d": "83.19",
"may_5e": "211.94",
"june_5f": "2077.84",
"july_5g": "2066.84",
"august_5h": "3090.84",
"september_5i": "6793.09",
"october_5j": "2269.41",
"november_5k": "2115.08",
"december_5l": "3007.04",
"state_6": "MA",
"state_id_7": null,
"state_income_8": null
},
"warnings": [
{
"field_name": "recipient_tin",
"message": "recipient_tin obfuscated",
"severity": 0.0
},
{
"field_name": "pse_name_phone",
"message": "pse_name_phone value empty/bad format",
"severity": 0.0
},
{
"field_name": "gross_1b",
"message": "gross_1b value empty/bad format",
"severity": 0.0
},
{
"field_name": "no_transactions_3",
"message": "no_transactions_3 not found",
"severity": 0.0
},
{
"field_name": "fed_inc_tax_4",
"message": "fed_inc_tax_4 value empty/bad format",
"severity": 0.0
},
{
"field_name": "state_id_7",
"message": "state_id_7 not found",
"severity": 0.0
},
{
"field_name": "state_income_8",
"message": "state_income_8 value empty/bad format",
"severity": 0.0
}
],
"confidence": "EXACT_MATCH",
"ocr_page_count": 1
}
Endpoints
These are the endpoints available for documents
.
Endpoints |
---|
Retrieve a document - GET /documents/:id |
List documents - GET /documents |
Example object
{
"id": "110a6cd9-2cd5-3a8e-b8db-3fae4e96b58a",
"account": "e0c16ace-0628-25da-8928-5dffd7a7b1d1",
"employer": "walmart",
"created_at": "2020-11-18T12:27:30.478199Z",
"updated_at": "2020-11-29T08:33:41.525392Z",
"document_number": "T1234567",
"document_type": "W-2",
"document_type_description": "W-2 Form 2019",
"expiration_date": "null",
"available_date": "2020-02-15T00:00:00Z",
"file_url": "https://argyle-api-prod-uploads.storage.googleapis.com/e0c16ace-0628-25da-8928-5dffd7a7b1d1-20200016",
"metadata": {}
}