# ML # ML Document and image models: signature detection, hosted document extraction, and the training-data pipelines behind them. Two model families. Signature detection answers whether a page carries a signature and where, which is what makes an executed-document check automatic. Document extraction reads fields from a page image. Training data comes from a labelling pipeline that annotates real mortgage documents rather than generated ones, and accuracy per vendor and per document type is reported by Document. ## How it works Hosting a vendor's extraction engine rather than calling its API was a deliberate option, and the deployment path for it is Host. The choice turns on where the document is allowed to be, not on which is easier to integrate. ## Operations ### AWSDocumentAI `POST` `/document` #### OCR process document `document` Long-running operation endpoint to process document by AWS Textract OCR. ##### Request application/json Copy An example of a batch request. Presigned URLs shown here are just examples, you need to provide valid and active Presigned URLs when making the request. ``` { "urls": [ "https://somebucketname.s3.us-east-1.amazonaws.com/test.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host", "https://somebucketname.s3.us-east-1.amazonaws.com/MultiDocs_10_pages.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host", "https://somebucketname.s3.us-east-1.amazonaws.com/Form1040_Leo.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host" ] } ``` ##### Response 200400 application/json400 text/html401403 application/json Copy Ok. ``` { "documents_info": [ { "uuid": "2db2abe018862e9c4e4cf340696da14ecf3ff37ba153d68ab6796433468e5e48", "url": "https://files.consumerfinance.gov/f/201311_cfpb_kbyo_closing-disclosure.pdf" } ] } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Request body`application/json` 2 fields | Field | Type | Description | | --- | --- | --- | | `urls`required | `string[]` | One or more Presigned URLs of PDFs to extract data from. | | `processor` | `string` | Name of AWS DocumentAI processor to be used for data extractionExample `irs_w2` | ##### Response `200``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `documents_info` | `object[]` | Array of IDs for query results of OCR. | | `uuids` | `object` | UUIDs associated with the documents being processed as part of the batch. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `GET` `/test-model/{job_id}` #### Retrieve Extracted Data `test-model-status` Get test train document status This service allows getting result of test model. ##### Response 200401403404 application/json Copy Ok. ``` { "code": 200, "pages": [ { "num": 1, "width": 612, "height": 792, "id": "01FQ1V5WYZCKMAZ0DQQNTVPC3C" } ], "annotations": [ { "annotation_spec_id": 5708576960238584000, "display_name": "has_social_security_number", "text_extraction": { "score": 0.9998301267623901, "text_segment": { "start_offset": 86, "end_offset": 96, "content": "123-45-678" } }, "page": "01FQ1V5WYZCKMAZ0DQQNTVPC3C", "bounding_box": { "top_ratio": 0.7323232293128967, "left_ratio": 0.4901960790157318, "height_ratio": 0.012626290321350098, "width_ratio": 0.09477123618125916 } } ], "document_text": "For Official Use Only\nOMB No. XXXXXXX\n22222\na Employee's social security number\nVoid\n123-45-678", "transaction_id": "df5039ba-c650-4e73-8b0a-af6e0b031c15", "train_product_id": "01FQBA6JJNHHN57RBKP0VZPYV4", "processed_pages_count": 8, "units": 33 } ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy File not found ``` { "code": "Not Found", "message": "Nothing matches the given URI" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `job_id` required | `string` path | `d8b01c18-10f7-4a71-962-43eeaed5ae6b` | Job ID of the test document operation. | ##### Response `200``application/json` 8 fields Ok. | Field | Type | Description | | --- | --- | --- | | `code` | `number` | Test model status code.Example `200` | | `pages` | `object[]` | List of pages. | | `id` | `string` | Unique page identifier.Example `01FQ1V5WYZMGW5SQTKQH1DSMTX` | | `num` | `number` | Page number.Example `1` | | `width` | `number` | Page width in points.Example `612` | | `height` | `number` | Page height in points.Example `792` | | `annotations` | `object[]` | Annotations elements | | `annotation_spec_id` | `integer` | Annotation identification. | | `display_name` | `string` | Annotation name. | | `text_extraction` | `object` | Extraction object. | | `score` | `number` | Annotation score. | | `text_segment` | `object` | Text Segment object. | | `start_offset` | `integer` | Character offsets rather than byte offsets. | | `end_offset` | `integer` | Character offsets rather than byte offsets. | | `content` | `string` | Annotation content. | | `page` | `string` | Page identifier.Example `01FQ1V5WYZMGW5SQTKQH1DSMTX` | | `bounding_box` | `object` | Bounding boxes of extracted text. | | `top_ratio` | `number` | Top ratio of bounding boxExample `0.7462121248245239` | | `left_ratio` | `number` | Left ratio of bounding boxExample `0.779411792755127` | | `height_ratio` | `number` | Height ratio of bounding boxExample `0.010101020336151123` | | `width_ratio` | `number` | Width ratio of bounding boxExample `0.026143789291381836` | | `train_product_id` | `string` | Unique train product execution ID.Example `01FQBA6JJNHHN57RBKP0VZPYV4` | | `transaction_id` | `string` | Transaction ID for the generated health metrics.Example `df5039ba-c650-4e73-8b0a-af6e0b031c15` | | `document_text` | `string` | Content of extract file.Example `For Official Use Only OMB No. XXXXXXX 22222 a Employee's social security number Void 123-45-678` | | `processed_pages_count` | `number` | Count of processed pages. It can be the same or less than in the original document.Example `8` | | `units` | `number` | Count of comprehend units used for extraction.Example `33` | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields File not found | Field | Type | Description | | --- | --- | --- | | `error` | `object` | File not found error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Reason why document was not extracted.Example `Test model result contains overlapped annotations` | `POST` `/generate-gs` #### Convert GTL and OCR to annotations `generate-gs` Convert GTL and OCR input to annotations. Annotations will be used for training models for AWS Comprehend. ##### Request application/json Copy ``` { "gtl": { "documents": [ { "@type": "closing_disclosure" } ] }, "gc_presigned_download_urls": [ "https://dev-data-manager-blobs-bucket-us-east-1-1111111.s3.amazonaws.com/foo.json?" ] } ``` ##### Request body`application/json` 2 fields | Field | Type | Description | | --- | --- | --- | | `gtl`required | `object` | Input from GTL | | `documents` | `object[]` | Array of documents from GTL | | `@type`required | `string` | Document typeExample `closing_disclosure` | | `gc_presigned_download_urls`required | `string[]` | Presigned URL for document | ##### Response `200``application/json` 2 fields Successful response. | Field | Type | Description | | --- | --- | --- | | `annotations` | `object[]` | Array of labels, contains label name, value, GTL value and text segment info. | | `displayName` | `string` | Data point (label) name | | `value` | `string` | Value for this data point | | `gtlValue` | `string` | GTL value for this data point, usually V2 output | | `textExtraction` | `object` | Data about where this data point is located in document | | `page` | `number` | Page numberExample `1` | | `textSegment` | `object` | Where data point text starts and ends. | | `startOffset` | `number` | Index of text start | | `endOffset` | `number` | Index of text end | | `document` | `object` | Data about text for each page in document | | `documentText` | `object` | Object with data for text extracted | ##### Response `400``application/json` 1 fields Incorrect payload | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Reason why request was not processed.Example `Error on getting data from presigned URL` | `GET` `/models` #### Retrieve Trained Models `get-models` Get trained models This service allows getting a list of trained Comprehend models. ##### Response 200401 application/json Copy Ok. ``` { "count": 2, "models": [ { "name": "mortgage-insurance-certificate", "versions": [ { "name": "2022-05-12-10-25-09", "precision": 62.68656716417911, "annotations": [ "has_organization_name", "has_insurance_policy_identifier", "has_insurance_policy_effective_date", "has_mortgage_insurance_premium_rate_percent", "has_mortgage_insurance_duration_type", "has_mortgage_insurance_premium_paid_by_type", "has_mortgage_insurance_coverage_percent", "has_mortgage_insurance_premium_refundable_type", "has_mortgage_insurance_premium_calculation_type", "has_mortgage_insurance_third_premium_rate_percent", "has_mortgage_insurance_subsequent_premium_rate_percent" ] } ] }, { "name": "closing-disclosure", "versions": [ { "name": "2022-05-12-13-49-36", "precision": 72.83441367118444, "annotations": [ "applicant_document_date", "product", "loan_type", "sale_price", "interest_rate", "monthly_principal_interest", "mortgage_insurance_required", "property_taxes_in_escrow", "homeowners_insurance_in_escrow", "prepaid_property_taxes_months", "prepaid_property_taxes_amount", "loan_disclosures_assumption", "loan_disclosures_late_payment", "applicant_document_signature" ] }, { "name": "2022-03-31-20-54-33", "precision": 58.03921568627452, "annotations": [ "has_prepaid_taxes_months_count", "has_prepaid_taxes_amount", "has_assumability_indicator", "has_late_charge_type", "has_document_date", "has_loan_amortization_type", "has_mortgage_insurance_required_indicator", "has_tax_escrow_required_indicator", "has_hazard_insurance_escrow_required_indicator" ] } ] } ] } ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` ##### Response `200``application/json` 2 fields Ok. | Field | Type | Description | | --- | --- | --- | | `count` | `number` | Count of trained modelsExample `11` | | `models` | `object[]` | List of models. | | `name` | `string` | Model name.Example `closing-disclosure` | | `versions` | `object[]` | List of versions. | | `name` | `string` | Version name.Example `2022-05-12-10-25-09` | | `precision` | `number` | Version precision.Example `70.35830618892508` | | `annotations` | `string[]` | List of trained annotations. | | `status` | `string` | Status of the version. Only trained or imported models are used for extraction.Example `TRAINED` | | `message` | `string` | Message about model version status.Example `TRAINED` | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/setting` #### Settings `settings` AWS Comprehend settings. Can be used for update inference units count to increase throughput. 1 inference unit corresponds to throughput in 100 characters per second. ##### Request application/json Copy ``` { "inference_units_count": 3 } ``` ##### Response 202400 application/json400 text/html403 application/json Copy Request accepted. ``` { "message": "Settings have been successfully updated" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `inference_units_count`required | `integer` | Comprehend inference units count. | ##### Response `202``application/json` 1 fields Request accepted. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Response message | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ### ML `POST` `/extract` #### Detect human signature `detectSignature` Check if PDF contains a human written signature ##### Response 200400 application/json400 text/html403 application/json Copy Ok. ``` { "job_id": "WB6XV833KNWF0GZ7" } ``` application/json Copy Bad Request. ``` { "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Response `200``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `job_id` | `string` | Extraction job ID | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | `POST` `/extract/{job_id}` #### Detect human signature status `detectSignatureStatus` Check status of extraction job ##### Response 200400 application/json400 text/html403404 application/json Copy Ok. ``` { "is_signed": true, "page": 7 } ``` application/json Copy Bad Request. ``` { "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Forbidden ``` { "message": "Extraction job not found" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `job_id` required | `string` path | `WB6XV833KNWF0GZ7` | Extraction Job ID. | ##### Response `200``application/json` 2 fields Ok. | Field | Type | Description | | --- | --- | --- | | `is_signed` | `boolean` | Is document signed | | `page` | `number` | Page with signature | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | ### Platform `GET` `/products/train_data_extraction/response-schema` #### Retrieve Response Schema `retrieveResponseSchema` Retrieve Schema retrieves a JSON schema for the response returned by the product. It can also return an example for the response output object through return_example attribute. ##### Response 200400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500 application/json Copy Successfully returned the list of elements of response of the product waterfall. ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` application/json Copy Error ``` { "message": "Please provide one of valid return examples values: true, false" } ``` text/html Copy Error ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "description": "Error Message.", "type": "string" } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `return_examples` | `boolean` query | `false` | If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false` | ##### Response `200``application/json` 1 fields Successfully returned the list of elements of response of the product waterfall. | Field | Type | Description | | --- | --- | --- | | `schema` | `object` | Element key / value element | ##### Response `400``application/json` 1 fields Error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message. | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `GET` `/transactions/{transaction_id}/collections` #### Retrieve Transaction Collections `RetrieveTransactionCollections` Retrieve Transaction Collections returns the content of a given `collection_id` associated with a specific `transaction_id`. ##### Response 200400403404500 application/json Copy Transaction collection retrieved successfully ``` { "data": {} } ``` text/html Copy Error ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "message": "Unable to get collections of given transaction. Please check the transaction id" } ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier | ##### Response `200``application/json` 4 fields Transaction collection retrieved successfully | Field | Type | Description | | --- | --- | --- | | `collection_id` | `string (ulid)` | Collection idExample `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `data` | `array` | The data | | `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema | | `transaction_id` | `string (ulid)` | Transaction idExample `01EZQ32PJQGKRA6HR8D72Q9FFF` | ##### Response `400``application/json` 1 fields Error | Field | Type | Description | | --- | --- | --- | | `message` | `one of` | Either message object with more properties. | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `PUT` `/transactions/{transaction_id}/collections/{collection_id}` #### Update Collection `updateCollection` Update Collection allows you to update the content of a given `collection_id` associated with a `transaction_id`. ##### Request application/json Copy ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` ##### Response 200400 UpdateCollectionError400 text/html403404 UpdateCollectionError404 text/html500 application/json Copy Collection updated successfully ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` application/json Copy Error ``` { "description": "Error details.", "message": "Unable to update collection. Please check the collection data" } ``` text/html Copy Error ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "message": "Unable to update collection. Please check the given ids" } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier | | `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Staircase collection_id | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `data` | `object` | The data object | ##### Response `200``application/json` 1 fields Collection updated successfully | Field | Type | Description | | --- | --- | --- | | `data` | `object` | The data object | ##### Response `400``application/json` 1 fields Error | Field | Type | Description | | --- | --- | --- | | `message` | `one of` | Either message object with more properties. | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | ### DocumentAI `POST` `/setup-credentials` #### Set Up Google Cloud Account Credentials `setup-credentials` Setup Google Cloud service account credentials Setup Google Cloud credentials in the form of a service account key in order to authenticate an application as a service account. ##### Request application/json Copy An example of a Google Cloud service account key. The key shown is just an example, you need to provide a valid key in order to use the service. ``` { "type": "service_account", "project_id": "my-great-project-1234560", "private_key_id": "aeb28addda999e5dde66de00041a1fd99ed7e4a32", "private_key": "", "client_email": "name-of-the-service-account@my-great-project-1234560.iam.gserviceaccount.com", "client_id": "378463746364563353673", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/name-of-the-service-account%40my-great-project-1234560.iam.gserviceaccount.com" } ``` ##### Response 200400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "code": "200", "message": "The credentials have been saved." } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Request body`application/json` 10 fields | Field | Type | Description | | --- | --- | --- | | `type`required | `string` | The type of member this key is for.Example `service_account` | | `project_id`required | `string` | The project identifier.Example `my-great-project-1234560` | | `private_key_id`required | `string` | The project key identifier.Example `aeb28addda999e5dde66de00041a1fd99ed7e4a32` | | `private_key`required | `string` | The private key contents.Example `` | | `client_email`required | `string` | The client emails.Example `name-of-the-service-account@my-great-project-1234560.iam.gserviceaccount.com` | | `client_id`required | `string` | The client id.Example `378463746364563353673` | | `auth_uri`required | `string` | The authorization URI.Example `https://accounts.google.com/o/oauth2/auth` | | `token_uri`required | `string` | The token URI.Example `https://oauth2.googleapis.com/token` | | `auth_provider_x509_cert_url`required | `string` | The URL of the public x509 certificate provider.Example `https://www.googleapis.com/oauth2/v1/certs` | | `client_x509_cert_url`required | `string` | The RL of the public x509 certificate.Example `https://www.googleapis.com/robot/v1/metadata/x509/name-of-the-service-account%40my-great-project-1234560.iam.gserviceaccount.com` | ##### Response `200``application/json` 2 fields Ok. | Field | Type | Description | | --- | --- | --- | | `code` | `string` | Status code. | | `message` | `string` | The message. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/batch-process-document` #### Process Batch `new-batch` Long-running operation endpoint to batch process many documents. ##### Request application/json Copy An example of a batch request. Presigned URLs shown here are just examples, you need to provide valid and active Presigned URLs when making the request. ``` { "urls": [ "https://somebucketname.s3.us-east-1.amazonaws.com/test.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host", "https://somebucketname.s3.us-east-1.amazonaws.com/MultiDocs_10_pages.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host", "https://somebucketname.s3.us-east-1.amazonaws.com/Form1040_Leo.pdf?X-Amz-Algorithm=&X-Amz-Credential=%2F20180210%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=&X-Amz-Expires=1800&X-Amz-Signature=&X-Amz-SignedHeaders=host" ] } ``` ##### Response 200400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "documents_info": [ { "uuid": "4a58346a-dc5b-4678-bc9c-3553952a896b", "url": "https://files.consumerfinance.gov/f/201311_cfpb_kbyo_closing-disclosure.pdf" } ] } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Request body`application/json` 2 fields | Field | Type | Description | | --- | --- | --- | | `urls`required | `string[]` | One or more Presigned URLs of PDFs to extract data from. | | `processor` | `string` | Name of DocumentAI processor to be used for data extractionExample `irs_w2` | ##### Response `200``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `documents_info` | `object[]` | UUIDs associated with the documents being processed as part of the batch. | | `uuid` | `string (uuid)` | Unique ID for querying results.Example `4a58346a-dc5b-4678-bc9c-3553952a896b` | | `url` | `string (uri)` | URL for file from request.Example `https://files.consumerfinance.gov/f/201311_cfpb_kbyo_closing-disclosure.pdf` | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `GET` `/document/{uuid}` #### Retrieve Extracted Data `retrieve-extracted-data` Retrieve extracted data Retrieves the extracted data of a document based on the UUID assigned to it when accepted to be processed as part of a batch operation. ##### Response 400 application/json400 text/html401403408409500501502503 application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `uuid` required | `string` path | `d8b01c18-10f7-4a71-962-43eeaed5ae6b` | UUID of the document which extracted data it's being requested. | ##### Response `200``application/json` 6 fields Ok. | Field | Type | Description | | --- | --- | --- | | `uri` | `string` | Google Storage location where the file was uploaded to be processed by Document AI.Example `gs://staircase-host-documentai/batch/input/d8b01c18-10f7-4a71-9612-43eeaed5ae6b-test.pdf` | | `mimeType` | `string` | Mime type of the documentExample `application/pdf` | | `text` | `string` | Extracted data as plain textExample `22222 Void 999-00-0000 a Employee’s social security number For Official Use Only ▶ OMB No. 1545-0008 b Employer identification number (EIN) 1 Wages, tips, other compensation 2 Federal income tax withheld 12-3456789 c Employer’s name, address, and ZIP code 3 Social security wages 4 Social security tax withheld Ocrolus Inc. 101 Greenwich Street, Floor 23 New York, NY 10006 5 Medicare wages and tips 6 6 Medicare tax withheld 7 Social security tips 8 Allocated tips d Control number 9 10 Dependent care benefits e Employee’s first name and initial Last name Suff. M99999 John Doe 123 Main Street New York, NY 10001 100000.00 15000.00 98750.00 7500.00 98750.00 4500.00 0.00 0.00 0.00 D 1000.00 x 11 Nonqualified plans 12a See instructions for box 12 C o d e 13 Statutory Retirement Third-party employee plan sick pay 12b C o d e 14 Other 12c C o d e 12d C o d e NY-PFR 223.25 f Employee’s address and ZIP code 15 State Employer’s state ID number 16 State wages, tips, etc. 17 State income tax 18 Local wages, tips, etc. 19 Local income tax 20 Locality name NY | 999999999 100000.00 9000.00 W-2 Wage and Tax Statement Form 2019 Copy A For Social Security Administration — Send this entire page with Form W-3 to the Social Security Administration; photocopies are not acceptable. Department of the Treasury—Internal Revenue Service For Privacy Act and Paperwork Reduction Act Notice, see the separate instructions. Cat. No. 10134D Do Not Cut, Fold, or Staple Forms on This Page` | | `pages` | `object[]` | Pages of the document | | `entities` | `object[]` | Entities of the document | | `shardInfo` | `object` | Share info of the document | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 2 fields Not found. | Field | Type | Description | | --- | --- | --- | | `code` | `string` | Error type.Example `Not Found` | | `message` | `string` | Reason of errorExample `Nothing matches the given uuid` | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/document-type` #### Create New Document Type `document-type` Create new document type. Create new document type to train a model with DocumentAI. ##### Request application/json Copy An example of a document type. ``` { "name": "W-2" } ``` ##### Response 201400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "message": "The data started to import successfully" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `name`required | `string` | The name of document type. | ##### Response `201``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | The message. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `GET` `/auto-train` #### Retrieve auto train configurations `reetrieve-auto-train-configurations` Get a list of automatic training configurations with statuses and ready-to-train document counts. ##### Response 200403 application/json Copy Ok. ``` [ { "documentType": "W-2", "enabled": true, "readyForTrainCount": 12 }, { "documentType": "closing_disclosure", "enabled": false, "readyForTrainCount": 20 } ] ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Response `200``application/json` 3 fields Ok. | Field | Type | Description | | --- | --- | --- | | `documentType` | `string` | Document type.Example `W-2` | | `enabled` | `boolean` | Is auto training enabled.Example `true` | | `readyForTrainCount` | `number` | Ready for training documents count.Example `12` | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | `PUT` `/auto-train/{document_type_name}` #### Auto Train Document Type `auto-train-document` Auto train document type Inserting a configuration to enable automatic training of document type. ##### Request application/json Copy An example of configuration. ``` { "enabled": true } ``` ##### Response 201400 application/json400 text/html403 application/json Copy Ok. ``` { "message": "Auto training configuration successfully created" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type_name` required | `string` path | `W-2` | The name of document type | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `enabled`required | `boolean` | Status of auto training.Example `true` | ##### Response `201``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Configuration creation message.Example `Auto training configuration successfully created` | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | message | `PUT` `/train-document/{document_type_name}` #### Train Document Type `train-document` Train document type This service imports documents annotations and labels to a document type created. The model is trained when the number of documents is enough to train, validate and test. ##### Request application/json Copy An example of document. ``` [ { "annotations": [ { "displayName": "Employee_lastname", "textExtraction": { "textSegment": { "startOffset": "794", "endOffset": "800" } } } ], "document": { "documentText": { "content": "Safe, Accurate,\nVisit the IRS Website\na Employee's social" } } } ] ``` ##### Response 200400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "code": "200", "message": "The data started to import successfully" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type_name` required | `string` path | `W-2` | The name of document type | ##### Request body`application/json` 4 fields | Field | Type | Description | | --- | --- | --- | | `annotations` | `object[]` | — | | `displayName` | `string` | Name of annotations.Example `Employee_lastname` | | `textExtraction` | `object` | — | | `textSegment` | `object` | — | | `startOffset` | `string` | Start of annotation.Example `794` | | `endOffset` | `string` | End of annotation.Example `800` | | `document` | `object` | — | | `documentText` | `object` | — | | `content` | `string` | Content of annotation.Example `Safe, Accurate, Visit the IRS Website a Employee's social` | | `document_url` | `string` | Download URL of the document.Example `https://foobarwebsite.com/filename.pdf` | | `dataset_id_to_train` | `string` | Dataset ID to be trained.Example `foobarid123` | ##### Response `200``application/json` 2 fields Ok. | Field | Type | Description | | --- | --- | --- | | `code` | `one of` | Status code. | | `message` | `string` | The message. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | message | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/test-model` #### Test Train Document Type `test-model` Test train document type This service allows to test a document type created and trained with DocumentAI. ##### Request application/json Copy An example of test a model. ``` { "document_type_name": "W-2", "url": "https://www.example.com/test.pdf", "transaction_id": "01ARZ3NDEKTSV4RRFFQ69G5FAV" } ``` ##### Response 200400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "code": 200, "pages": [ { "num": 1, "width": 612, "height": 792, "id": "01FQ1V5WYZCKMAZ0DQQNTVPC3C" } ], "annotations": [ { "annotation_spec_id": 5708576960238584000, "display_name": "has_social_security_number", "text_extraction": { "score": 0.9998301267623901, "text_segment": { "start_offset": 86, "end_offset": 96, "content": "123-45-678" } }, "page": "01FQ1V5WYZCKMAZ0DQQNTVPC3C", "bounding_box": { "top_ratio": 0.7323232293128967, "left_ratio": 0.4901960790157318, "height_ratio": 0.012626290321350098, "width_ratio": 0.09477123618125916 } } ], "document_text": "For Official Use Only\nOMB No. XXXXXXX\n22222\na Employee's social security number\nVoid\n123-45-678", "transaction_id": "df5039ba-c650-4e73-8b0a-af6e0b031c15", "train_product_id": "01FQBA6JJNHHN57RBKP0VZPYV4" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `model_id` | `string` query | `TEN8439699522203942912` | Specific model ID | ##### Request body`application/json` 3 fields | Field | Type | Description | | --- | --- | --- | | `document_type_name`required | `string` | The name of document type. | | `url`required | `string` | URL file. | | `transaction_id` | `string` | Transaction ID. Generated by default | ##### Response `200``application/json` 6 fields Ok. | Field | Type | Description | | --- | --- | --- | | `code` | `number` | Test model status code.Example `200` | | `pages` | `object[]` | List of pages. | | `id` | `string` | Unique page identifier.Example `01FQ1V5WYZMGW5SQTKQH1DSMTX` | | `num` | `number` | Page number.Example `1` | | `width` | `number` | Page width in points.Example `612` | | `height` | `number` | Page height in points.Example `792` | | `annotations` | `object[]` | Annotations elements | | `annotation_spec_id` | `integer` | Annotation identification. | | `display_name` | `string` | Annotation name. | | `text_extraction` | `object` | Extraction object. | | `score` | `number` | Annotation score. | | `text_segment` | `object` | Text Segment object. | | `start_offset` | `integer` | Character offsets rather than byte offsets. | | `end_offset` | `integer` | Character offsets rather than byte offsets. | | `content` | `string` | Annotation content. | | `page` | `string` | Page identifier.Example `01FQ1V5WYZMGW5SQTKQH1DSMTX` | | `bounding_box` | `object` | Bounding boxes of extracted text. | | `top_ratio` | `number` | Top ratio of bounding boxExample `0.7462121248245239` | | `left_ratio` | `number` | Left ratio of bounding boxExample `0.779411792755127` | | `height_ratio` | `number` | Height ratio of bounding boxExample `0.010101020336151123` | | `width_ratio` | `number` | Width ratio of bounding boxExample `0.026143789291381836` | | `train_product_id` | `string` | Unique train product execution ID.Example `01FQBA6JJNHHN57RBKP0VZPYV4` | | `transaction_id` | `string` | Transaction ID for the generated health metrics.Example `df5039ba-c650-4e73-8b0a-af6e0b031c15` | | `document_text` | `string` | Content of extract file.Example `For Official Use Only OMB No. XXXXXXX 22222 a Employee's social security number Void 123-45-678` | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `GET` `/status-document/{document_type_name}` #### Retrieve Status of Training Document `get-status-document` Get status of training document This service retrieves the status of the document in the DocumentAI training ##### Response 201400 application/json400 text/html401403404408409500501502503 application/json Copy Ok. ``` { "status": "COMPLETE" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy File not found ``` { "code": "Not Found", "message": "Nothing matches the given URI" } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type_name` required | `string` path | `W-2` | The name of document type | ##### Response `201``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `status` | `string` | The status can be IN PROGRESS or COMPLETEExample `COMPLETE` | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields File not found | Field | Type | Description | | --- | --- | --- | | `error` | `object` | File not found error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `GET` `/status-credentials` #### Get Status of Credentials `get-status-credentials` Get status of credentials This service retrieves the status of the credentials ##### Response 201400 application/json400 text/html401403404408409500501502503 application/json Copy Ok. ``` { "status": "COMPLETE" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy File not found ``` { "code": "Not Found", "message": "Nothing matches the given URI" } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Response `201``application/json` 1 fields Ok. | Field | Type | Description | | --- | --- | --- | | `status` | `string` | The status can be IN PROGRESS or COMPLETEExample `COMPLETE` | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields File not found | Field | Type | Description | | --- | --- | --- | | `error` | `object` | File not found error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/create-model` #### Create Model `create-model` Create model This service allows creating new model. But process lasts around 3 hours. ##### Request application/json Copy An example of create a model. ``` { "document_type_name": "W-2" } ``` ##### Response 200400 application/json400 text/html401403408409500501502503 application/json Copy Ok. ``` { "code": "200", "message": "The process to create the new model has started. The process lasts about 3 hours" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Request Timeout. ``` { "code": "408", "message": "SoftworksAI partner is not available." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Not Implemented ``` { "code": "501", "message": "Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` application/json Copy Service Unavailable ``` { "code": "503", "message": "Error" } ``` ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `document_type_name`required | `string` | The name of document type. | ##### Response `200``application/json` 3 fields Ok. | Field | Type | Description | | --- | --- | --- | | `code` | `one of` | Status code. | | `operation` | `string` | Operation id of transaction. | | `message` | `string` | The message. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `408``application/json` 1 fields Request Timeout. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Timeout error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `501``application/json` 1 fields Not Implemented | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `503``application/json` 1 fields Service Unavailable | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `PATCH` `/documents/{document_type}` #### Update document `updateDocument` Update document, currently only model ID can be updated ##### Request application/json Copy An example of document update. ``` { "model_id": "23ff8e7e-765a-414f-bb04-969298b81c19" } ``` ##### Response 400 application/json400 text/html403 application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type` required | `string` path | `W-2` | Document type. | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `model_id`required | `string` | Model id | ##### Response `200``application/json` 1 fields Model updated | Field | Type | Description | | --- | --- | --- | | `document` | `object` | Document | | `document_type` | `string` | Document type | | `dataset_id` | `string` | Dataset ID | | `model_id` | `string` | Model ID | | `count_docs` | `number` | Count docs | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields Not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message | `GET` `/documents/{document_type}/models` #### Retrieve document models `retireveDocumentModels` ##### Response 400 application/json400 text/html403404 application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy File not found ``` { "code": "Not Found", "message": "Nothing matches the given URI" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type` required | `string` path | `W-2` | Document type. | ##### Response `200``application/json` 1 fields Document models | Field | Type | Description | | --- | --- | --- | | `models` | `object[]` | Models. | | `model_id` | `string` | Model ID. | | `dataset_id` | `string` | Dataset ID. | | `status` | `string` | Deployment status`deployed``deployment_state_unspecified``undeployed` | | `create_time` | `string (datetime)` | Time when the model training finished and can be used for prediction. | | `update_time` | `string (datetime)` | Time when this model was last updated. | | `active` | `boolean` | Is active flag | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields File not found | Field | Type | Description | | --- | --- | --- | | `error` | `object` | File not found error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `POST` `/create-dataset` #### Create New Dataset `create-dataset` Create new Dataset. Create new Dataset for a specific document type. ##### Request application/json Copy An example of a document type. ``` { "document_type": "closing_disclosure", "dataset_name": "dt_closing_disclosure_23" } ``` ##### Response 201400 application/json400 text/html401403409500502 application/json Copy Created. ``` { "message": "The Dataset was created successfully" } ``` application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Unauthorized. ``` { "code": "401", "message": "This token is not valid for this service." } ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy Conflict ``` { "code": "409", "message": "Batch already exists" } ``` application/json Copy Internal Server Error ``` { "code": "500", "message": "Internal Server Error" } ``` application/json Copy Bad Gateway ``` { "code": "502", "message": "Error" } ``` ##### Request body`application/json` 4 fields | Field | Type | Description | | --- | --- | --- | | `document_type`required | `string` | The name of document type. | | `dataset_name`required | `string` | The name of the Dataset. | | `required_labels` | `string[]` | The labels that are required in the Dataset. | | `acceptable_labels` | `string[]` | The labels that are acceptable in the Dataset. | ##### Response `201``application/json` 1 fields Created. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | The message. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `401``application/json` 1 fields Unauthorized. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Unauthorized error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `409``application/json` 1 fields Conflict | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `422``application/json` 1 fields Unprocessable entity | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `500``application/json` 1 fields Internal Server Error | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Response `502``application/json` 1 fields Bad Gateway | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Conflict error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | `DELETE` `/documents/{document_type}/models/{model_id}` #### Delete model `deleteModel` Delete trained model. ##### Response 400 application/json400 text/html403404 application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` application/json Copy File not found ``` { "code": "Not Found", "message": "Nothing matches the given URI" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `document_type` required | `string` path | `W-2` | Document type. | | `model_id` required | `string` path | `TEN0007099176139227136` | Model ID. | | `force` | `boolean` query | `false` | Include model deletion from GCP. | ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Response `404``application/json` 1 fields File not found | Field | Type | Description | | --- | --- | --- | | `error` | `object` | File not found error. | | `code`required | `string` | Error name. | | `message`required | `string` | Error description. | ##### Other responses `204` ### Workflow `POST` `/transactions` #### Create Transaction `createTransaction` Create Transaction creates a transaction in Staircase. Transactions in Staircase are containers for all the data related to an instance of a transaction type. They enable you to correlate the output of various products to a single transaction type, where the transaction type depends on your line of business. Transactions are identified by a unique key called `transaction_id`. As you use different Staircase products to gather the data needed for a specific instance of your transaction type, and receive different sets of output from each product, use the same transaction_id to correlate all the outputs to the same transaction. A `transaction_id`, when used properly, gives you a holistic view of the data related to the transaction you’ve assembled. To access all collections associated with a given transaction_id, try out /transactions/{transaction_id}/collections ##### Response 201403500 application/json Copy Transaction created successfully ``` { "created_at": "03/04/2021, 1:04:05 PM EST", "transaction_id": "01F0KHK7DN3H5JZ4QJKMYAM6GB" } ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | ##### Response `201``application/json` 2 fields Transaction created successfully | Field | Type | Description | | --- | --- | --- | | `created_at` | `string` | Staircase time string.Example `03/03/2021, 8:24:04 AM EST` | | `transaction_id` | `string (ulid)` | Staircase Transaction IdentifierExample `01F0KHK7DN3H5JZ4QJKMYAM6GB` | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `POST` `/blobs/upload` #### Upload Document `uploadBlob` Upload Blob allows a customer to upload a document in .pdf form. Upload Blob uploads a .pdf document (blob) to Persistence product. You can upload PDF using HTML Request Maker Try It Out. Place your API key in the request header, set the request body to binary and browse to your document. Click Send to upload your document. To upload a document programmatically, use the programmatic upload example below. After the approval document is successfully uploaded, a blob_id value is provided. Example: 'blob_id': '01EZYHKY4EXFW4Z8RKWHDP1KHB' After you got successful response, you need to use the blob_id in collection with the following path. Show the rest ``` $.document_sets.document_set[0].documents.document[0].foreign_objects.foreign_object[0].staircase_blob_id ``` To upload a document within code, you can to use a below example. ``` import requests with open("document.pdf", "rb") as document: payload = document.read url = "" headers = { "x-api-key": ..., "Content-Type": "application/pdf" } response = requests.post(url, headers=headers, data=payload) if response.ok: blob_id = response.json["blob_id"] ``` ##### Request application/octet-stream Copy ``` Select option 'binary' in order to upload file ``` ##### Response 201403500 application/json Copy Blob uploaded ``` { "blob_id": "01EZY9J8SEFM2JKDJ1Q3YX65HS" } ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | ##### Response `201``application/json` 1 fields Blob uploaded | Field | Type | Description | | --- | --- | --- | | `blob_id` | `string` | Created blob id | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | ##### Other responses `400``405``422` `GET` `/products/train_data_extraction/request-schema` #### Retrieve Request Schema `retrieveRequestSchema` Retrieve Request Schema retrieves a JSON schema for the request to the product waterfall. It also has the option of returning an example for the request object expected through the return_example attribute. ##### Response 200400 InvalidReturnExamplesValue400 text/html403404 GetProduct404 text/html500 application/json Copy Successfully returned the list of elements needed for product waterfall. ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` application/json Copy Error ``` { "message": "Please provide one of valid return examples values: true, false" } ``` text/html Copy Error ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "description": "Error Message.", "type": "string" } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `return_examples` | `boolean` query | `false` | If included and set to `true`, returns one or more pre-filled examples that conform to the schema. Default to `false` | ##### Response `200``application/json` 1 fields Successfully returned the list of elements needed for product waterfall. | Field | Type | Description | | --- | --- | --- | | `schema` | `object` | Element key / value | ##### Response `400``application/json` 1 fields Error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message. | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `POST` `/transactions/{transaction_id}/collections` #### Create Collection `createCollection` Create Collection creates a collection of data points required for product invocation. A collection contains a digital representation of the input or output data for the product and is identified by `collection_id`. The Example below contains a sample collection that you can use to make the product invocation in /get-collection ##### Request application/json Copy ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` ##### Response 201400 CreateCollectionError400 text/html403404 CreateCollectionError404 text/html500 application/json Copy Collection created successfully ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` application/json Copy Error ``` { "message": "Unable to create collection. Please check the collection data" } ``` text/html Copy Error ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "message": "Unable to create collection. Please check the transaction ID." } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `data` | `object` | The data object | ##### Response `201``application/json` 4 fields Collection created successfully | Field | Type | Description | | --- | --- | --- | | `collection_id` | `string (ulid)` | Collection idExample `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `data` | `array` | The data | | `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema | | `transaction_id` | `string (ulid)` | Transaction idExample `01EZQ32PJQGKRA6HR8D72Q9FFF` | ##### Response `400``application/json` 1 fields Error | Field | Type | Description | | --- | --- | --- | | `message` | `one of` | Either message object with more properties. | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `POST` `/products/train_data_extraction/invocations` #### Extract data from document `InvokeSpecificProductFlow` Invoke TrainDataExtraction Invoke Specific Product Flow helps you to invoke specific product flow, this endpoint shall: - Validate the input `transaction_id`, `request_collection_id`, `response_collection_id` if provided; - Create transaction if the `transaction_id` was not provided; - Create input collection with the `request_data` provided if the `request_collection_id` was not provided; - Create empty output collection if the `response_collection_id` was not provided; - Validate the provided product name and the product flow name; - Retrieve the product flow information associated to the provided Product Flow Name; Show the rest - Translate the input collection from Staircase language to Vendor language if `input_translation_language` was configured for the product flow; - Run the connector flow associated to the Product Flow Name; - Set the status, `invocation_id` and `output_translation_language` that will be used to translate the results from Vendor Language to Staircase language if `output_translation_language` was configured for the product flow. - Send a callback, when the flow execution will be finished if `callback_url` was specified with an input data for the invocation. The callback request body is a JSON with the following schema: ``` { "type": "object", "$schema": "", "required": [ "invocation_id", "invocation_status" ], "properties": { "invocation_id": { "type": "string", "format": "uuid" }, "invocation_status": { "type": "string", "enum": [ "COMPLETED", "FAILED" ] }, "response_data": { "type": "object", "additionalProperties": true }, "failure_reason": { "type": "string" } } } ``` ##### Request application/json Copy ``` { "callback_url": "https://webhook.site/3706b519-9426-4533-9868-14a7dec4fd97", "product_flow_name": "Alloy", "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN", "response_collection_id": "01F6NAQ4894HPMCBGB4P0G95XK", "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4" } ``` ##### Response 201400403404500 application/json Copy Successfully started flow invocation. ``` { "invocation_id": "9aefb465-90fb-4d50-8ae6-2df2b58373f4", "output_language_name": "staircase", "request_collection_id": "01F6NAQ4894HPMCBGB4P0G95XK", "response_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN", "invocation_status": "STARTED", "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | ##### Request body`application/json` 7 fields | Field | Type | Description | | --- | --- | --- | | `callback_url` | `string (uri)` | Callback URL. | | `product_flow_name` | `string` | Product flow name. If it is not specified, the default product flow will be invoked. If the product has no default product flow, the first created flow will be invoked. Cannot be specified together with vendor_name. | | `request_collection_id` | `string` | Request Collection ID. | | `request_data` | `object` | Request JSON body. | | `response_collection_id` | `string` | Response Collection ID. | | `transaction_id` | `string` | Transaction ID used for invocation. | | `vendor_name` | `string` | Vendor name. Cannot be specified together with product_flow_name. | ##### Response `201``application/json` 7 fields Successfully started flow invocation. | Field | Type | Description | | --- | --- | --- | | `callback_url` | `string` | Callback URL. | | `invocation_id`required | `string` | Invocation ID. | | `invocation_status`required | `string` | The status of the invocation.`STARTED` | | `metadata` | `object` | The metadata of the invoked product flow. | | `product_flow_name` | `string` | Product flow name. | | `request_data` | `object` | The data for the request collection. | | `transaction_id`required | `string` | Transaction ID. | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `GET` `/products/train_data_extraction/invocations/{invocation_id}` #### Retrieve Status `RetrieveProductFlowInvocationStatus` Status Retrieves the status of running Product flow invocation. ##### Response 200400403404500 application/json Copy Successfully returned status of the Product flow Invocation. ``` { "request_collection_id": "01F6QF1QJF20DMSXH4SYXKB1SN", "response_collection_id": "01F6NAQ4894HPMCBGB4P0G95XK", "invocation_status": "COMPLETED", "transaction_id": "01F6NAMXWN2XVBD1YJ92A6S6R4", "updated_at": "2021-05-27T15:17:59.859954-04:00" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` text/html Copy Resource not found ``` \r\n\r\n\r\n

400 Bad Request

\r\n\r\n\r\n ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `invocation_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Product flow invocation identifier | ##### Response `200``application/json` 9 fields Successfully returned status of the Product flow Invocation. | Field | Type | Description | | --- | --- | --- | | `callback_url` | `string` | URL that was specified in flow invocation and will be used to send the callback when flow invocation will be finished. | | `invocation_status`required | `string` | Invocation Status.`ACTION_REQUIRED``COMPLETED``FAILED``RUNNING``STARTED` | | `metadata` | `object` | Response Collection ID. | | `request_collection` | `object` | Collection. | | `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `data` | `object` | Data in Staircase language schema. | | `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. | | `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `request_collection_id` | `string` | Request Collection ID. | | `response_collection` | `object` | Collection. | | `collection_id` | `string (ulid)` | Collection ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `data` | `object` | Data in Staircase language schema. | | `metadata` | `object` | Metadata about collection, f.e version of used Staircase schema. | | `transaction_id` | `string (ulid)` | Transaction ID.Example `01EZQ32PJQGKRA6HR8D72Q9FFF` | | `response_collection_id` | `string` | Response Collection ID. | | `transaction_id`required | `string` | Transaction ID used for invocation. | | `widget_url` | `string (uri)` | URL of the widget. | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | `GET` `/transactions/{transaction_id}/collections/{collection_id}` #### Retrieve Collection `retrieveCollection` Retrieve Collection returns the content of a given `collection_id` associated with a `transaction_id`. ##### Response 200403404 GetCollectionError404 GetCollectionsError500 application/json Copy Successfully Retrieved Collection ``` { "addresses": [ { "address_line_1_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "56319 Underwood Views", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MQEN90HSCMPQWCAD", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.13863636363636364, "has_bounding_box_width_ratio": 0.23529411764705882, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "address_line_2_text": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Lake Debramouth NE 33667-9751", "with_data_extraction_metadata": { "@id": "01FBHPXCJ110EKH48ZQEK3YQFF", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.07352941176470588, "has_bounding_box_top_ratio": 0.15636363636363637, "has_bounding_box_width_ratio": 0.31411764705882356, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "documents": [ { "@id": "01FBHN4YR48XC75HJF5Z9VRBTV", "@type": "irs_w2", "has_staircase_blob_identifier": { "has_value": "01FBHN11S8SF835QXB8M1EBZGG" }, "with_page_extraction_metadata": [ { "@id": "01FBHPXCJ03V0AAHVGW6G1YE08", "page_height": 2200, "page_number": 1, "page_width": 1700 } ] } ], "employment": [ { "retirement_plan_participant_indicator": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "x", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1BN0A4XXXG5ZSD8K0", "has_bounding_box_height_ratio": 0.013181818181818182, "has_bounding_box_left_ratio": 0.6194117647058823, "has_bounding_box_top_ratio": 0.26590909090909093, "has_bounding_box_width_ratio": 0.02, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "income": [ { "allocated_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1ZTCHXGVK108FHVHE", "has_bounding_box_height_ratio": 0.016363636363636365, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.17227272727272727, "has_bounding_box_width_ratio": 0.10058823529411764, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "dependent_care_benefits_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "219", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MM5FMP6HGKC606ZD", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8129411764705883, "has_bounding_box_top_ratio": 0.2018181818181818, "has_bounding_box_width_ratio": 0.04352941176470588, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_1_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "678-77-709", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1W0SMD3JVDE47N116", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.1288235294117647, "has_bounding_box_top_ratio": 0.3663636363636364, "has_bounding_box_width_ratio": 0.11411764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "employer_state_2_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "940-46-434", "with_data_extraction_metadata": { "@id": "01FBHPXCJ12M1K4ASVZBF68XHJ", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.12823529411764706, "has_bounding_box_top_ratio": 0.39181818181818184, "has_bounding_box_width_ratio": 0.11588235294117646, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "federal_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "40043.57", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FE1EQ8X9Q3N12W4F", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.77, "has_bounding_box_top_ratio": 0.09181818181818181, "has_bounding_box_width_ratio": 0.09058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9966", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P0KJ87SMG4T98B75", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8182352941176471, "has_bounding_box_top_ratio": 0.23318181818181818, "has_bounding_box_width_ratio": 0.05058823529411765, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12a_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FF708969HFCH40NT", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7847058823529411, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.021176470588235293, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12b_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "284", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1VT54M1WB8JCK60N2", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.2636363636363636, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "307", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1122YD0V4AVKZENYF", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.295, "has_bounding_box_width_ratio": 0.03705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12c_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "P", "with_data_extraction_metadata": { "@id": "01FBHPXCJ17CSM3TM4RXJ81SBQ", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.29545454545454547, "has_bounding_box_width_ratio": 0.02823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "242", "with_data_extraction_metadata": { "@id": "01FBHPXCJ14CVKQT2JE5BGCGCG", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.8188235294117647, "has_bounding_box_top_ratio": 0.3277272727272727, "has_bounding_box_width_ratio": 0.03764705882352941, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "irs_w2_box_12d_code": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "H", "with_data_extraction_metadata": { "@id": "01FBHPXCJ15PYMH0E9SDPSFAFS", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.7817647058823529, "has_bounding_box_top_ratio": 0.3286363636363636, "has_bounding_box_width_ratio": 0.02588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "152406.79", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1FRRA33BQ5Y1WPBZB", "has_bounding_box_height_ratio": 0.015, "has_bounding_box_left_ratio": 0.5735294117647058, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.09823529411764706, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "medicare_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "4419.8", "with_data_extraction_metadata": { "@id": "01FBHPXCJ165FBQES8CNY03WXV", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.8176470588235294, "has_bounding_box_top_ratio": 0.14772727272727273, "has_bounding_box_width_ratio": 0.07176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "nonqualified_retirement_plan_distribution_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "233", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1SH6XFDXZEW448H6A", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.23272727272727273, "has_bounding_box_width_ratio": 0.04176470588235294, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_income_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1MX04VCHK51H8RMF2", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.10705882352941176, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tax_withheld_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "9459.67", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1X5EE4TPRBM2CH0M3", "has_bounding_box_height_ratio": 0.017272727272727273, "has_bounding_box_left_ratio": 0.768235294117647, "has_bounding_box_top_ratio": 0.11818181818181818, "has_bounding_box_width_ratio": 0.07882352941176471, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_tips_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "123655.86", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1P9044AEFH8EF6QT7", "has_bounding_box_height_ratio": 0.014090909090909091, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.175, "has_bounding_box_width_ratio": 0.10470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "wages_salaries_tips_and_other_compensation_amount": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "126204.09", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1Y43WKTXBJJWHE106", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.571764705882353, "has_bounding_box_top_ratio": 0.08954545454545454, "has_bounding_box_width_ratio": 0.10588235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "mortgage_products": [ { "@id": "01FBHN4YR4H8E04K9RJZ3F8CRH", "@type": "groundtruth_labeling", "has_service_request_date": { "has_value": "2021-07-26" }, "has_service_response_date": { "has_value": "2021-07-26" }, "product_used_for": "01FBHN4YR48XC75HJF5Z9VRBTV" } ], "organizations": [ { "organization_identifier": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "39-3114215", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0H5YE99DKRNXTVR5W", "has_bounding_box_height_ratio": 0.015454545454545455, "has_bounding_box_left_ratio": 0.08058823529411764, "has_bounding_box_top_ratio": 0.09136363636363637, "has_bounding_box_width_ratio": 0.12, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "organization_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Carlson Group Group", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1NYMK9JRAAMF3GXRH", "has_bounding_box_height_ratio": 0.01681818181818182, "has_bounding_box_left_ratio": 0.07470588235294118, "has_bounding_box_top_ratio": 0.11954545454545455, "has_bounding_box_width_ratio": 0.2211764705882353, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ], "people": [ { "full_name": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "Taylor Cox", "with_data_extraction_metadata": { "@id": "01FBHPXCJ1011XSCSZ76ZE1CX0", "has_bounding_box_height_ratio": 0.02181818181818182, "has_bounding_box_left_ratio": 0.07588235294117647, "has_bounding_box_top_ratio": 0.2381818181818182, "has_bounding_box_width_ratio": 0.13470588235294118, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } }, "social_security_number": { "data_sourced_from": "01FBHN4YR4H8E04K9RJZ3F8CRH", "has_value": "999-00-0000", "with_data_extraction_metadata": { "@id": "01FBHPXCJ0VCNHZCXPKJ3WY9C8", "has_bounding_box_height_ratio": 0.015909090909090907, "has_bounding_box_left_ratio": 0.26588235294117646, "has_bounding_box_top_ratio": 0.06363636363636363, "has_bounding_box_width_ratio": 0.1288235294117647, "with_page_extraction_metadata": "01FBHPXCJ03V0AAHVGW6G1YE08" } } } ] } ``` application/json Copy 403 invalid error ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Resource not found ``` { "message": "Unable to get collection. Please check the given ids" } ``` application/json Copy Resource not found ``` { "message": "Unable to get collections of given transaction. Please check the transaction id" } ``` application/json Copy Internal server error ``` { "message": "The product has encountered an internal server error. If you have used a transaction_id to call our services, please submit it to Staircase support" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `transaction_id` required | `string (ulid)` path | `01F0KHK7DN3H5JZ4QJKMYAM6GB` | Staircase Transaction Identifier | | `collection_id` required | `string (ulid)` path | `01F0KHKADN0HRFXMCQQXPA6AFZ` | Staircase collection_id | ##### Response `200``application/json` 1 fields Successfully Retrieved Collection | Field | Type | Description | | --- | --- | --- | | `data` | `object` | The data object | ##### Response `403``application/json` 2 fields 403 invalid error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | | `url` | `string` | Error additional URL. | ##### Response `404``application/json` 1 fields Resource not found | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `500``application/json` 1 fields Internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error message. | ##### Other responses `400` `GET` `/products/train_data_extraction/custom_endpoint/models` #### Retrieve List Of Supported Document Types `RetrieveDoctypes` Successfully returned list of supported document types and partners. Retrieves the list of currently supported documents and partners per document. Best partner for each document type is provided. Customers can use it when invoking product flow as tag in order to extract with this particular partner. ##### Response application/json Copy Successfully returned list of supported document types and partners. ``` { "collection_id": "01G0YH8WJYNHN72ANQ8DYG976M", "data": { "documents": [ { "document_type": "appraisal_report", "partners": [ "google_clould_nl" ], "default_partner": "google_clould_nl" }, { "document_type": "closing_disclosure", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "mortgage_insurance_cancellation_disclosure", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "google_clould_nl" }, { "document_type": "mortgage_insurance_certificate", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "note", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "property_insurance_policy", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "security_instrument", "partners": [ "google_clould_nl", "comprehend" ], "default_partner": "comprehend" }, { "document_type": "standard_flood_hazard_determination", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "title_commitment", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "underwriting_transmittal", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" }, { "document_type": "uniform_residential_loan_application", "partners": [ "google_clould_nl", "comprehend", "mindee" ], "default_partner": "comprehend" } ] }, "transaction_id": "01G0YH8WAREZS5WFZP3CPCT2W9", "metadata": { "created_at": "2022-04-18T10:29:51.838440-04:00", "validation": false } } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | | `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | The environment API key. | ##### Response `200``application/json` 4 fields Successfully returned list of supported document types and partners. | Field | Type | Description | | --- | --- | --- | | `collection_id` | `string` | Collection IDExample `01G0YH8WJYNHN72ANQ8DYG976M` | | `data` | `object` | Object with info about partners available for each document type. | | `documents` | `object[]` | Array of documents | | `document_type` | `string` | Document type name. Apply this to product tags when invoking product flow to extract particular document.Example `appraisal_report` | | `partners` | `string[]` | Array of partners available for particular document. | | `default_partner` | `string` | Best partner for this document type according to our recommendations.Example `google_clould_nl` | | `transaction_id` | `string` | Transaction IDExample `01G0YH8WAREZS5WFZP3CPCT2W9` | | `metadata` | `object` | Collection metadata | | `created_at` | `string` | Created dateExample `2022-04-18T10:29:51.838440-04:00` | | `validation` | `boolean` | Is validation enabledExample `false` | ### Operations `POST` `/credentials` #### Setup pipeline credentials ##### Response 400 application/json400 text/html403 application/json Copy Bad Request. ``` { "code": "Bad Request", "message": "Bad request syntax or unsupported method" } ``` text/html Copy Bad Request. ``` Bad request syntax or unsupported method ``` application/json Copy Forbidden ``` { "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post", "message": "This key is not valid for this service." } ``` ##### Response `400``application/json` 1 fields Bad Request. | Field | Type | Description | | --- | --- | --- | | `error` | `object` | Bad Request error. | | `code`required | `one of` | Bad Request | | `message`required | `string` | Error description. | ##### Response `403``application/json` 2 fields Forbidden | Field | Type | Description | | --- | --- | --- | | `url` | `string` | The URL. | | `message` | `string` | Error message. | ##### Other responses `202` `POST` `/hello-world` #### Hello World Dummy hello world endpoint ##### Other responses `200` ## Canonical model - `document` ## Errors `400``401``403``404``405``408``409``422``500``501``502``503` ## More in Data - Previous product: Language - Next product: Persistence