openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 110 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://api.docspring.com/api/v1"}],"info":{"contact":{"x-twitter":"form_api"},"description":"DocSpring is a service that helps you fill out and sign PDF templates.","title":"API v1","version":"v1","x-apisguru-categories":["text"],"x-logo":{"url":"https://twitter.com/getdocspring/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://docspring.com/api-docs/v1/swagger.json","version":"3.0"}],"x-providerName":"formapi.io"},"paths":{"/authentication":{"get":{"operationId":"testAuthentication","responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"status":"success"}}},"schema":{"properties":{"status":{"enum":["success"],"type":"string"}},"required":["status"],"title":"authentication_success_response","type":"object"}}},"description":"authentication succeeded"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Test Authentication","tags":["PDF"]}},"/combined_submissions":{"get":{"operationId":"listCombinedSubmissions","parameters":[{"description":"Default: 1","example":2,"in":"query","name":"page","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Default: 50","example":1,"in":"query","name":"per_page","required":false,"schema":{"maximum":50,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":[{"actions":[],"download_url":null,"error_message":null,"expired":false,"expires_at":null,"expires_in":null,"id":"com_000000000000000001","metadata":{},"password":null,"pdf_hash":null,"processed_at":null,"source_pdfs":[],"state":"pending","submission_ids":[]},{"actions":[],"download_url":"https://example.com/combined_submissions/combined_submission.pdf","error_message":null,"expired":false,"expires_at":null,"expires_in":null,"id":"com_000000000000000002","metadata":{},"password":null,"pdf_hash":null,"processed_at":"2025-04-15T13:50:47.710Z","source_pdfs":[],"state":"processed","submission_ids":[]},{"actions":[],"download_url":null,"error_message":"Something went wrong","expired":false,"expires_at":null,"expires_in":123,"id":"com_000000000000000003","metadata":{},"password":null,"pdf_hash":null,"processed_at":null,"source_pdfs":[],"state":"error","submission_ids":[]},{"actions":[],"download_url":null,"error_message":null,"expired":true,"expires_at":"2025-04-15T13:50:47.710Z","expires_in":345,"id":"com_000000000000000004","metadata":{},"password":null,"pdf_hash":null,"processed_at":"2025-04-15T13:50:47.710Z","source_pdfs":[],"state":"processed","submission_ids":[]}]}},"schema":{"items":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/combined_submission_action"},"type":"array"},"download_url":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"expired":{"type":"boolean"},"expires_at":{"nullable":true,"type":"string"},"expires_in":{"nullable":true,"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"password":{"nullable":true,"type":"string"},"pdf_hash":{"nullable":true,"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"state":{"enum":["pending","processed","error"],"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","state","expired","submission_ids","source_pdfs"],"title":"combined_submission","type":"object"},"title":"combined_submissions","type":"array"}}},"description":"enumerate all combined submissions"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Get a list of all combined submissions","tags":["PDF"]},"post":{"operationId":"combineSubmissions","requestBody":{"content":{"application/json":{"schema":{"example":{"expires_in":300,"metadata":{"bar":"baz","foo":123},"password":"p@ssword","submission_ids":["sub_000000000000000001","sub_000000000000000002"]},"properties":{"expires_in":{"type":"integer"},"metadata":{"type":"object"},"password":{"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"},"test":{"type":"boolean"}},"required":["submission_ids"],"title":"combined_submission_data","type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"combined_submission":{"actions":[],"download_url":null,"error_message":null,"expired":false,"expires_at":null,"expires_in":300,"id":"com_000000000000000001","metadata":{"bar":"baz","foo":123},"password":"p@ssword","pdf_hash":null,"processed_at":null,"source_pdfs":[],"state":"pending","submission_ids":["sub_000000000000000001","sub_000000000000000002"]},"status":"success"}}},"schema":{"properties":{"combined_submission":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/combined_submission_action"},"type":"array"},"download_url":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"expired":{"type":"boolean"},"expires_at":{"nullable":true,"type":"string"},"expires_in":{"nullable":true,"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"password":{"nullable":true,"type":"string"},"pdf_hash":{"nullable":true,"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"state":{"enum":["pending","processed","error"],"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","state","expired","submission_ids","source_pdfs"],"title":"combined_submission","type":"object"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"}},"required":["status","combined_submission"],"title":"create_combined_submission_response","type":"object"}}},"description":"combined submission created"},"400":{"content":{"application/json":{"examples":{"response":{"value":{"error":"There was a problem with the JSON you submitted: unexpected character at line 1, column 37 in '{ \"submission_ids\": [\"123\", \"345\"], metadata: { \"user_id\": \"@#)(*%$)@(#*%@&%\" }}","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"invalid JSON"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"422":{"content":{"application/json":{"examples":{"response":{"value":{"errors":["source_pdfs: Could not find Submission with ID: MISSING_ID"],"status":"error"}}},"schema":{"$ref":"#/components/schemas/invalid_request"}}},"description":"invalid request"}},"security":[{"api_token_basic":[]}],"summary":"Merge generated PDFs together","tags":["PDF"]}},"/combined_submissions/{combined_submission_id}":{"delete":{"operationId":"expireCombinedSubmission","parameters":[{"example":"com_000000000000000001","in":"path","name":"combined_submission_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"actions":[{"action_category":"file_upload","action_type":"aws_s3_upload","id":"csa_000000000000000001","integration_id":"aci_000000000000000001","result_data":{"s3_bucket":"docspring-custom-s3-test","s3_key":"acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf","s3_region":"us-east-1","s3_url":"https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"},"state":"processed"}],"download_url":null,"error_message":null,"expired":true,"expires_at":"2025-04-15T13:50:47.710Z","expires_in":300,"id":"com_000000000000000001","metadata":{"qux":"abc","user_id":42},"password":"p@ssword","pdf_hash":"12342342471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","processed_at":"2025-04-15T13:50:47.710Z","source_pdfs":[],"state":"processed","submission_ids":["sub_000000000000000001","sub_000000000000000002"]}}},"schema":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/combined_submission_action"},"type":"array"},"download_url":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"expired":{"type":"boolean"},"expires_at":{"nullable":true,"type":"string"},"expires_in":{"nullable":true,"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"password":{"nullable":true,"type":"string"},"pdf_hash":{"nullable":true,"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"state":{"enum":["pending","processed","error"],"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","state","expired","submission_ids","source_pdfs"],"title":"combined_submission","type":"object"}}},"description":"submission was expired"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"403":{"content":{"application/json":{"examples":{"response":{"value":{"error":"You must use a live API token to expire a combined submission.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"test API token used"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Combined submission not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"combined submission not found"}},"security":[{"api_token_basic":[]}],"summary":"Expire a combined submission","tags":["PDF"]},"get":{"operationId":"getCombinedSubmission","parameters":[{"example":"com_000000000000000001","in":"path","name":"combined_submission_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"actions":[{"action_category":"file_upload","action_type":"aws_s3_upload","id":"csa_000000000000000001","integration_id":"aci_000000000000000001","result_data":{"s3_bucket":"docspring-custom-s3-test","s3_key":"acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf","s3_region":"us-east-1","s3_url":"https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"},"state":"processed"}],"download_url":"https://example.com/combined_submissions/combined_submission.pdf","error_message":null,"expired":false,"expires_at":"2025-04-15T13:50:47.710Z","expires_in":300,"id":"com_000000000000000001","metadata":{"qux":"abc","user_id":42},"password":"p@ssword","pdf_hash":"12342342471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","processed_at":"2025-04-15T13:50:47.710Z","source_pdfs":[],"state":"processed","submission_ids":["sub_000000000000000001","sub_000000000000000002"]}}},"schema":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/combined_submission_action"},"type":"array"},"download_url":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"expired":{"type":"boolean"},"expires_at":{"nullable":true,"type":"string"},"expires_in":{"nullable":true,"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"password":{"nullable":true,"type":"string"},"pdf_hash":{"nullable":true,"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"state":{"enum":["pending","processed","error"],"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","state","expired","submission_ids","source_pdfs"],"title":"combined_submission","type":"object"}}},"description":"processed combined submission found"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Combined submission not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"combined submission not found"}},"security":[{"api_token_basic":[]}],"summary":"Check the status of a combined submission (merged PDFs)","tags":["PDF"]}},"/combined_submissions?v=2":{"post":{"operationId":"combinePdfs","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"example":{"delete_custom_files":true,"expires_in":300,"metadata":{"bar":"baz","foo":123},"source_pdfs":[{"id":"sub_000000000000000001","type":"submission"},{"id":"tpl_000000000000000001","type":"template"},{"id":"sub_000000000000000002","type":"submission"},{"id":"cfi_0000000000000000000000001","type":"custom_file"},{"id":"com_000000000000000001","type":"combined_submission"},{"type":"url","url":"http://example.com/test-pdf.pdf"}]},"properties":{"delete_custom_files":{"type":"boolean"},"expires_in":{"type":"integer"},"metadata":{"type":"object"},"password":{"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"test":{"type":"boolean"}},"required":["source_pdfs"],"title":"combine_pdfs_data","type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"combined_submission":{"actions":[{"action_category":"file_upload","action_type":"aws_s3_upload","id":"csa_000000000000000002","integration_id":"aci_000000000000000001","result_data":{"s3_bucket":"docspring-custom-s3-test","s3_key":"acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf","s3_region":"us-east-1","s3_url":"https://docspring-custom-s3-test.s3.amazonaws.com/acc_1234/2018/combined_submissions/20181005090010-com_1234.pdf"},"state":"processed"}],"download_url":null,"error_message":null,"expired":false,"expires_at":null,"expires_in":300,"id":"com_000000000000000002","metadata":{"bar":"baz","foo":123},"password":null,"pdf_hash":null,"processed_at":null,"source_pdfs":[{"id":"sub_000000000000000001","type":"submission"},{"id":"tpl_000000000000000001","type":"template"},{"id":"sub_000000000000000002","type":"submission"},{"id":"cfi_0000000000000000000000001","type":"custom_file"},{"id":"com_000000000000000001","type":"combined_submission"},{"type":"url","url":"http://example.com/test-pdf.pdf"}],"state":"pending","submission_ids":["sub_000000000000000001","sub_000000000000000002"]},"status":"success"}}},"schema":{"properties":{"combined_submission":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/combined_submission_action"},"type":"array"},"download_url":{"nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"expired":{"type":"boolean"},"expires_at":{"nullable":true,"type":"string"},"expires_in":{"nullable":true,"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"password":{"nullable":true,"type":"string"},"pdf_hash":{"nullable":true,"type":"string"},"source_pdfs":{"items":{"oneOf":[{"additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"enum":["submission","combined_submission","template","custom_file"],"type":"string"}},"required":["type","id"],"type":"object"},{"additionalProperties":false,"properties":{"type":{"enum":["url"],"type":"string"},"url":{"format":"uri","type":"string"}},"required":["type","url"],"type":"object"}]},"type":"array"},"state":{"enum":["pending","processed","error"],"type":"string"},"submission_ids":{"items":{"type":"string"},"type":"array"}},"required":["id","state","expired","submission_ids","source_pdfs"],"title":"combined_submission","type":"object"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"}},"required":["status","combined_submission"],"title":"create_combined_submission_response","type":"object"}}},"description":"combined submission created"},"400":{"content":{"application/json":{"examples":{"response":{"value":{"error":"There was a problem with the JSON you submitted: unexpected character at line 1, column 34 in '{ \"source_pdfs\": [\"123\", \"345\"], metadata: { \"user_id\": \"@#*&%)(@*#%&(@#!\" }}","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"invalid JSON"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"422":{"content":{"application/json":{"examples":{"response":{"value":{"errors":["source_pdfs: Could not find Submission with ID: MISSING_SUBMISSION_ID","source_pdfs: Template document is not processed: tpl_000000000000000001 (state: pending)","source_pdfs: Could not find Template with ID: MISSING_TEMPLATE_ID","source_pdfs: Could not find Custom File with ID: MISSING_CUSTOM_FILE_ID","source_pdfs: Could not find Combined Submission with ID: MISSING_COMBINED_SUBMISSION_ID"],"status":"error"}}},"schema":{"$ref":"#/components/schemas/invalid_request"}}},"description":"invalid request"}},"security":[{"api_token_basic":[]}],"summary":"Merge submission PDFs, template PDFs, or custom files","tags":["PDF"]}},"/custom_files":{"post":{"operationId":"createCustomFileFromUpload","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"example":{"cache_id":"00000000000000001.pdf"},"properties":{"cache_id":{"minLength":1,"type":"string"}},"required":["cache_id"],"title":"create_custom_file_data","type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"custom_file":{"id":"cfi_000000000000000001","url":"/uploads/test/store/acc_000000000000000001/custom_files/cfi_000000000000000001.pdf"},"status":"success"}}},"schema":{"properties":{"custom_file":{"additionalProperties":false,"properties":{"id":{"type":"string"},"url":{"type":"string"}},"required":["id","url"],"title":"custom_file","type":"object"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"}},"required":["status","custom_file"],"title":"create_custom_file_response","type":"object"}}},"description":"returns the custom file"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Create a new custom file from a cached presign upload","tags":["PDF"]}},"/data_requests/{data_request_id}":{"get":{"operationId":"getDataRequest","parameters":[{"example":"drq_000000000000000001","in":"path","name":"data_request_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"auth_phone_number_hash":"fdcc3985b0698d655137019b1e776171081369f0aad125b8c7f57af2b8225490","auth_provider":null,"auth_second_factor_type":"phone_number","auth_session_id_hash":null,"auth_session_started_at":"2025-04-15T13:50:47.711Z","auth_type":"password","auth_user_id_hash":"8ae0e445664ca53407906db8638d8ba07a2383f656383a4427bed1ab645ca29a","auth_username_hash":"b7c141423f7030a6a771563ee0731192ea871146653a3d0cf8f8b78ca8f9699b","completed_at":null,"data":{"last_name":"Smithers"},"email":"jdoe@example.com","fields":["last_name"],"id":"drq_000000000000000001","ip_address":"1.1.1.1","metadata":{"user_id":42},"name":"John Doe","order":1,"sort_order":0,"state":"pending","submission_id":"sub_000000000000000001","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36","viewed_at":null}}},"schema":{"$ref":"#/components/schemas/submission_data_request"}}},"description":"completed submission data request found"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Data request not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"submission data request not found"}},"security":[{"api_token_basic":[]}],"summary":"Look up a submission data request","tags":["PDF"]},"put":{"operationId":"updateDataRequest","parameters":[{"example":"drq_000000000000000001","in":"path","name":"data_request_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"auth_provider":"google","auth_session_id_hash":"8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92","auth_session_started_at":"2018-10-23 09:00:00 -0400","auth_type":"oauth","metadata":{"user_id":123}},"properties":{"auth_phone_number_hash":{"nullable":true,"type":"string"},"auth_provider":{"nullable":true,"type":"string"},"auth_second_factor_type":{"enum":["none","phone_number","totp","mobile_push","security_key","fingerprint"],"type":"string"},"auth_session_id_hash":{"nullable":true,"type":"string"},"auth_session_started_at":{"nullable":true,"type":"string"},"auth_type":{"enum":["none","password","oauth","email_link","phone_number","ldap","saml"],"type":"string"},"auth_user_id_hash":{"nullable":true,"type":"string"},"auth_username_hash":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"metadata":{"type":"object"},"name":{"nullable":true,"type":"string"},"order":{"type":"integer"}},"title":"update_submission_data_request_data","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"data_request":{"auth_phone_number_hash":null,"auth_provider":"google","auth_second_factor_type":"none","auth_session_id_hash":"8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92","auth_session_started_at":"2025-04-15T13:50:47.711Z","auth_type":"oauth","auth_user_id_hash":null,"auth_username_hash":null,"completed_at":null,"data":{"last_name":"Smithers"},"email":"jdoe@example.com","fields":["last_name"],"id":"drq_000000000000000001","ip_address":"1.1.1.1","metadata":{"user_id":123},"name":"John Doe","order":1,"sort_order":0,"state":"pending","submission_id":"sub_000000000000000001","user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36","viewed_at":null},"status":"success"}}},"schema":{"properties":{"data_request":{"$ref":"#/components/schemas/submission_data_request"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"}},"required":["status","data_request"],"title":"update_data_request_response","type":"object"}}},"description":"submission data request updated"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Data request not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"submission data request not found"},"422":{"content":{"application/json":{"examples":{"response":{"value":{"errors":["Data requests cannot be updated after they have been completed."],"status":"error"}}},"schema":{"$ref":"#/components/schemas/invalid_request"}}},"description":"invalid request"}},"security":[{"api_token_basic":[]}],"summary":"Update a submission data request","tags":["PDF"]}},"/data_requests/{data_request_id}/tokens":{"post":{"operationId":"createDataRequestToken","parameters":[{"example":"drq_000000000000000001","in":"path","name":"data_request_id","required":true,"schema":{"type":"string"}}],"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"status":"success","token":{"data_request_url":"http://app.docspring.local/data_requests/drq_000000000000000001?token_id=000000000000000001&token_secret=ABCDEF01234567890","expires_at":"2025-04-15T13:50:47.711Z","id":"000000000000000001","secret":"ABCDEF01234567890"}}}},"schema":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"},"token":{"properties":{"data_request_url":{"type":"string"},"expires_at":{"type":"string"},"id":{"type":"string"},"secret":{"type":"string"}},"required":["id","secret","expires_at","data_request_url"],"type":"object"}},"required":["status","token"],"title":"create_submission_data_request_token_response","type":"object"}}},"description":"token created"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Creates a new data request token for form authentication","tags":["PDF"]}},"/folders/":{"get":{"operationId":"listFolders","parameters":[{"description":"Filter By Folder Id","example":"fld_000000000000000002","in":"query","name":"parent_folder_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":[{"id":"fld_000000000000000003","name":"nested folder 1","parent_folder_id":"fld_000000000000000002","path":"/Folder 2"},{"id":"fld_000000000000000002","name":"Folder 2","parent_folder_id":null,"path":"/"},{"id":"fld_000000000000000001","name":"Folder 1","parent_folder_id":null,"path":"/"}]}},"schema":{"items":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent_folder_id":{"nullable":true,"type":"string"},"path":{"type":"string"}},"title":"folder","type":"object"},"title":"folders","type":"array"}}},"description":"enumerate all folders"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Get a list of all folders","tags":["PDF"]},"post":{"operationId":"createFolder","requestBody":{"content":{"application/json":{"schema":{"example":{"folder":{"name":"Folder 3"}},"properties":{"folder":{"properties":{"name":{"type":"string"},"parent_folder_id":{"type":"string"}},"required":["name"],"type":"object"}},"required":["folder"],"title":"create_folder_data","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"id":"fld_0000000000000000n1","name":"Folder 3","parent_folder_id":null,"path":"/"}}},"schema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent_folder_id":{"nullable":true,"type":"string"},"path":{"type":"string"}},"title":"folder","type":"object"}}},"description":"folder created inside another folder"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"parent folder doesnt exist"},"422":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent_folder_id":{"nullable":true,"type":"string"},"path":{"type":"string"}},"title":"folder","type":"object"}}},"description":"name already exist"}},"security":[{"api_token_basic":[]}],"summary":"Create a folder","tags":["PDF"]}},"/folders/{folder_id}":{"delete":{"operationId":"deleteFolder","parameters":[{"example":"fld_000000000000000001","in":"path","name":"folder_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"id":"fld_000000000000000001","name":"Folder 1","parent_folder_id":null,"path":"/"}}},"schema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent_folder_id":{"nullable":true,"type":"string"},"path":{"type":"string"}},"title":"folder","type":"object"}}},"description":"folder is empty"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"folder doesnt exist"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"folder has contents"}},"security":[{"api_token_basic":[]}],"summary":"Delete a folder","tags":["PDF"]}},"/folders/{folder_id}/move":{"post":{"operationId":"moveFolderToFolder","parameters":[{"example":"fld_000000000000000001","in":"path","name":"folder_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"parent_folder_id":"fld_000000000000000002"},"properties":{"parent_folder_id":{"type":"string"}},"title":"move_folder_data","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"id":"fld_000000000000000001","name":"Folder 1","parent_folder_id":"fld_000000000000000002","path":"/Folder 2"}}},"schema":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"parent_folder_id":{"nullable":true,"type":"string"},"path":{"type":"string"}},"title":"folder","type":"object"}}},"description":"move to root folder"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"parent folder doesnt exist"}},"security":[{"api_token_basic":[]}],"summary":"Move a folder","tags":["PDF"]}},"/folders/{folder_id}/rename":{"post":{"operationId":"renameFolder","parameters":[{"example":"fld_000000000000000001","in":"path","name":"folder_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"name":"Folder 3"},"properties":{"name":{"type":"string"}},"required":["name"],"title":"rename_folder_data","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"id":"fld_000000000000000001","name":"Folder 3","parent_folder_id":null,"path":"/"}}}}},"description":"successful rename"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"description":"folder doesnt belong to me"},"422":{"description":"name already exist"}},"security":[{"api_token_basic":[]}],"summary":"Rename a folder","tags":["PDF"]}},"/submissions":{"get":{"operationId":"listSubmissions","parameters":[{"example":"sub_list_000012","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"example":3,"in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"example":"2025-04-15T13:50:47.711Z","in":"query","name":"created_after","required":false,"schema":{"type":"string"}},{"example":"2025-04-15T13:50:47.711Z","in":"query","name":"created_before","required":false,"schema":{"type":"string"}},{"example":"test","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"example":true,"in":"query","name":"include_data","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"limit":3,"next_cursor":"sub_list_000003","submissions":[{"actions":[],"batch_id":null,"data":{"first_name":"John C. D. Rom Laserdisk F. Scott Fitzgerald","last_name":"Smith","phone_number":"+11234567890"},"data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":"2025-04-15T13:50:47.711Z","id":"sub_list_000001","json_schema_errors":[],"metadata":{"qux":"abc","user_id":42},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_list_000001/download","processed_at":"2025-04-15T13:50:47.711Z","referrer":null,"source":"api","state":"processed","template_id":"tpl_000000000000000001","test":true,"truncated_text":{"first_name":["F. Scott Fitzgerald"]}},{"actions":[],"batch_id":null,"data":{"first_name":"John C. D. Rom Laserdisk F. Scott Fitzgerald","last_name":"Smith","phone_number":"+11234567890"},"data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":"2025-04-15T13:50:47.711Z","id":"sub_list_000002","json_schema_errors":[],"metadata":{"qux":"abc","user_id":42},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_list_000002/download","processed_at":"2025-04-15T13:50:47.711Z","referrer":null,"source":"api","state":"processed","template_id":"tpl_000000000000000001","test":true,"truncated_text":{"first_name":["F. Scott Fitzgerald"]}},{"actions":[],"batch_id":null,"data":{"first_name":"John C. D. Rom Laserdisk F. Scott Fitzgerald","last_name":"Smith","phone_number":"+11234567890"},"data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":"2025-04-15T13:50:47.711Z","id":"sub_list_000003","json_schema_errors":[],"metadata":{"qux":"abc","user_id":42},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_list_000003/download","processed_at":"2025-04-15T13:50:47.711Z","referrer":null,"source":"api","state":"processed","template_id":"tpl_000000000000000001","test":true,"truncated_text":{"first_name":["F. Scott Fitzgerald"]}}]}}},"schema":{"properties":{"limit":{"type":"number"},"next_cursor":{"nullable":true,"type":"string"},"submissions":{"items":{"$ref":"#/components/schemas/submission"},"type":"array"}},"required":["submissions","limit","next_cursor"],"title":"list_submissions_response","type":"object"}}},"description":"listing submissions"},"400":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid submission type: 'foo'","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"invalid type"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"List all submissions","tags":["PDF"]}},"/submissions/batches":{"post":{"operationId":"batchGeneratePdfs","requestBody":{"content":{"application/json":{"schema":{"example":{"metadata":{"job_id":54321},"submissions":[{"data":{"first_name":"Johnny","last_name":"Smith"},"metadata":{"submission_number":1},"template_id":"tpl_000000000000000001","test":false},{"data":{"first_name":"Jane","last_name":"Doe"},"metadata":{"submission_number":2},"template_id":"tpl_000000000000000001"}],"template_id":null,"test":true},"properties":{"metadata":{"type":"object"},"submissions":{"items":{"properties":{"css":{"type":"string"},"data":{"type":"object"},"html":{"type":"string"},"metadata":{"type":"object"},"template_id":{"nullable":true,"type":"string"},"test":{"type":"boolean"}},"required":["template_id","data"],"title":"submission_data_batch_request","type":"object"},"type":"array"},"template_id":{"nullable":true,"type":"string"},"test":{"type":"boolean"}},"required":["submissions"],"title":"submission_batch_data","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"status":"error","submission_batch":{"completion_percentage":100,"error_count":1,"id":"sbb_000000000000000001","metadata":{"job_id":54321},"pending_count":0,"processed_at":null,"state":"error","total_count":2},"submissions":[{"status":"valid_but_not_saved"},{"errors":["Your submission data did not contain a required property of 'first_name'"],"status":"error","submission":{"actions":[],"batch_id":"sbb_000000000000000001","data_requests":[],"download_url":null,"editable":null,"expired":false,"expires_at":null,"id":"sub_000000000000000001","json_schema_errors":["Your submission data did not contain a required property of 'first_name'"],"metadata":{"submission_number":2},"password":null,"pdf_hash":null,"permanent_download_url":null,"processed_at":null,"state":"invalid_data","template_id":"tpl_000000000000000001","test":true,"truncated_text":{}}}]}}},"schema":{"properties":{"error":{"type":"string"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"},"submission_batch":{"properties":{"completion_percentage":{"type":"integer"},"error_count":{"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"pending_count":{"type":"integer"},"processed_at":{"nullable":true,"type":"string"},"state":{"enum":["pending","processed","error"],"type":"string"},"submissions":{"items":{"$ref":"#/components/schemas/submission"},"type":"array"},"total_count":{"type":"integer"}},"required":["id","total_count","pending_count","error_count","completion_percentage","state","processed_at","metadata"],"title":"submission_batch","type":"object"},"submissions":{"items":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error","valid_but_not_saved"],"type":"string"},"submission":{"$ref":"#/components/schemas/submission"}},"required":["status"],"title":"create_submission_batch_submissions_response","type":"object"},"type":"array"}},"required":["status","submission_batch","submissions"],"title":"create_submission_batch_response","type":"object"}}},"description":"some PDFs with invalid data"},"201":{"content":{"application/json":{"examples":{"response":{"value":{"status":"success","submission_batch":{"completion_percentage":0,"error_count":0,"id":"sbb_000000000000000001","metadata":{"job_id":54321},"pending_count":2,"processed_at":null,"state":"pending","total_count":2},"submissions":[{"status":"success","submission":{"actions":[],"batch_id":"sbb_000000000000000001","data_requests":[],"download_url":null,"editable":null,"expired":false,"expires_at":null,"id":"sub_000000000000000001","json_schema_errors":[],"metadata":{"submission_number":1},"password":null,"pdf_hash":null,"permanent_download_url":null,"processed_at":null,"state":"pending","template_id":"tpl_000000000000000001","test":false,"truncated_text":{}}},{"status":"success","submission":{"actions":[],"batch_id":"sbb_000000000000000001","data_requests":[],"download_url":null,"editable":null,"expired":false,"expires_at":null,"id":"sub_000000000000000002","json_schema_errors":[],"metadata":{"submission_number":2},"password":null,"pdf_hash":null,"permanent_download_url":null,"processed_at":null,"state":"pending","template_id":"tpl_000000000000000001","test":true,"truncated_text":{}}}]}}},"schema":{"properties":{"error":{"type":"string"},"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error"],"type":"string"},"submission_batch":{"properties":{"completion_percentage":{"type":"integer"},"error_count":{"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"pending_count":{"type":"integer"},"processed_at":{"nullable":true,"type":"string"},"state":{"enum":["pending","processed","error"],"type":"string"},"submissions":{"items":{"$ref":"#/components/schemas/submission"},"type":"array"},"total_count":{"type":"integer"}},"required":["id","total_count","pending_count","error_count","completion_percentage","state","processed_at","metadata"],"title":"submission_batch","type":"object"},"submissions":{"items":{"properties":{"errors":{"items":{"type":"string"},"type":"array"},"status":{"enum":["success","error","valid_but_not_saved"],"type":"string"},"submission":{"$ref":"#/components/schemas/submission"}},"required":["status"],"title":"create_submission_batch_submissions_response","type":"object"},"type":"array"}},"required":["status","submission_batch","submissions"],"title":"create_submission_batch_response","type":"object"}}},"description":"submissions created"},"400":{"content":{"application/json":{"examples":{"response":{"value":{"error":"There was a problem with the JSON you submitted: unexpected character at line 1, column 25 in '{ \"first_name\": \"John\", last_name: \"Smith\" }","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"invalid JSON"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"}},"security":[{"api_token_basic":[]}],"summary":"Generates multiple PDFs","tags":["PDF"]}},"/submissions/batches/{submission_batch_id}":{"get":{"operationId":"getSubmissionBatch","parameters":[{"example":"sbb_000000000000000001","in":"path","name":"submission_batch_id","required":true,"schema":{"type":"string"}},{"example":true,"in":"query","name":"include_submissions","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"completion_percentage":100,"error_count":2,"id":"sbb_000000000000000001","metadata":{"qux":"abc"},"pending_count":0,"processed_at":null,"state":"error","submissions":[{"actions":[],"batch_id":"sbb_000000000000000001","data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":null,"id":"sub_000000000000000001","json_schema_errors":[],"metadata":{},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_000000000000000001/download","processed_at":null,"state":"processed","template_id":"tpl_000000000000000001","test":false,"truncated_text":{}},{"actions":[],"batch_id":"sbb_000000000000000001","data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":null,"id":"sub_000000000000000002","json_schema_errors":[],"metadata":{},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_000000000000000002/download","processed_at":null,"state":"processed","template_id":"tpl_000000000000000001","test":false,"truncated_text":{}}],"total_count":10}}},"schema":{"properties":{"completion_percentage":{"type":"integer"},"error_count":{"type":"integer"},"id":{"type":"string"},"metadata":{"type":"object"},"pending_count":{"type":"integer"},"processed_at":{"nullable":true,"type":"string"},"state":{"enum":["pending","processed","error"],"type":"string"},"submissions":{"items":{"$ref":"#/components/schemas/submission"},"type":"array"},"total_count":{"type":"integer"}},"required":["id","total_count","pending_count","error_count","completion_percentage","state","processed_at","metadata"],"title":"submission_batch","type":"object"}}},"description":"processed submission batch found"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Submission batch not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"submission batch not found"}},"security":[{"api_token_basic":[]}],"summary":"Check the status of a submission batch job","tags":["PDF"]}},"/submissions/{submission_id}":{"delete":{"operationId":"expireSubmission","parameters":[{"example":"sub_000000000000000001","in":"path","name":"submission_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"actions":[{"action_category":"file_upload","action_type":"aws_s3_upload","id":"sba_000000000000000001","integration_id":"aci_000000000000000001","result_data":{"s3_bucket":"docspring-custom-s3-test","s3_key":"templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf","s3_region":"us-east-1","s3_url":"https://docspring-custom-s3-test.s3.amazonaws.com/templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf"},"state":"processed"}],"batch_id":null,"data_requests":[],"download_url":null,"editable":false,"expired":true,"expires_at":"2025-04-15T13:50:47.712Z","id":"sub_000000000000000001","json_schema_errors":[],"metadata":{"qux":"abc","user_id":42},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":null,"processed_at":"2025-04-15T13:50:47.712Z","state":"processed","template_id":"tpl_000000000000000001","test":true,"truncated_text":{"first_name":["F. Scott Fitzgerald"]}}}},"schema":{"$ref":"#/components/schemas/submission"}}},"description":"submission was expired"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Invalid API token secret"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"403":{"content":{"application/json":{"examples":{"response":{"value":{"error":"You must use a live API token to expire a submission.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"test API token used"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Submission not found.","status":"error"}}},"schema":{"$ref":"#/components/schemas/error"}}},"description":"submission not found"}},"security":[{"api_token_basic":[]}],"summary":"Expire a PDF submission","tags":["PDF"]},"get":{"operationId":"getSubmission","parameters":[{"example":"sub_000000000000000001","in":"path","name":"submission_id","required":true,"schema":{"type":"string"}},{"example":true,"in":"query","name":"include_data","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"actions":[{"action_category":"file_upload","action_type":"aws_s3_upload","id":"sba_000000000000000001","integration_id":"aci_000000000000000001","result_data":{"s3_bucket":"docspring-custom-s3-test","s3_key":"templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf","s3_region":"us-east-1","s3_url":"https://docspring-custom-s3-test.s3.amazonaws.com/templates/tpl_eGc5CmFbPnCCmerqsx/sub_gzYpKDYFqEHxzca4kK.pdf"},"state":"processed"}],"batch_id":null,"data":{"first_name":"John C. D. Rom Laserdisk F. Scott Fitzgerald","last_name":"Smith","phone_number":"+11234567890"},"data_requests":[],"download_url":"https://example.com/submissions/submission.pdf","editable":false,"expired":false,"expires_at":"2025-04-15T13:50:47.712Z","id":"sub_000000000000000001","json_schema_errors":[],"metadata":{"qux":"abc","user_id":42},"password":null,"pdf_hash":"bbc369dd471442006963e3244a1b43610e066165c09770978221f91bd7ace8f5","permanent_download_url":"http://app.docspring.local/submissions/sub_000000000000000001/download","processed_at":"2025-04-15T13:50:47.712Z","referrer":null,"source":"api","state":"processed","template_id":"tpl_000000000000000001","test":true,"truncated_text":{"first_name":["F. Scott Fitzgerald"]}}}},"schema":{"$ref":"#/components/schemas/submission"}}},"description":"processed submission found"},"401":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Unauthorized","status":"error"}}},"schema":{"$ref":"#/components/schemas/authentication_error"}}},"description":"authentication failed"},"404":{"content":{"application/json":{"examples":{"response":{"value":{"error":"Submission not found.","status":"error"}}},"sche