{"openapi":"3.0.0","info":{"title":"Stable API","version":"1"},"paths":{"/v1/companies":{"post":{"summary":"Create a company","description":"Creates a single company.","tags":["Companies"],"operationId":"createCompany.post.v1/companies","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"List all companies","description":"Returns a list of companies associated with your account.","tags":["Companies"],"operationId":"getCompanies.get.v1/companies","parameters":[{"in":"query","name":"id","required":false,"schema":{"type":"string"}},{"in":"query","name":"first","required":false,"schema":{"type":"string"}},{"in":"query","name":"after","required":false,"schema":{"type":"string"}},{"in":"query","name":"last","required":false,"schema":{"type":"string"}},{"in":"query","name":"before","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/jurisdictions/{jurisdiction}/filings":{"post":{"summary":"Place a filing","description":"Places a filing and charges for it. Retrying with the same Idempotency-Key and the same body returns the original filing instead of placing a second one.","tags":["Filings"],"operationId":"createFiling.post.v1/companies/{id}/jurisdictions/{jurisdiction}/filings","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"name":"jurisdiction","in":"path","required":true,"description":"Two-letter uppercase state code, such as `DE`.","schema":{"type":"string"}},{"in":"header","name":"idempotency-key","required":true,"description":"Your own key for this filing, 1 to 128 letters, digits, hyphens or underscores.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFilingRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Filing"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"402":{"description":"Payment was declined. Nothing was filed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingPaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingConflictError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"List a company's filings in one jurisdiction","description":"Returns the company's filings in this jurisdiction. The response has the same shape as the list of all the company's filings.","tags":["Filings"],"operationId":"getJurisdictionFilings.get.v1/companies/{id}/jurisdictions/{jurisdiction}/filings","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"name":"jurisdiction","in":"path","required":true,"description":"Two-letter uppercase state code, such as `DE`.","schema":{"type":"string"}},{"in":"query","name":"first","description":"Returns the first n results after the `after` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"after","description":"Returns results after this cursor. Use `endCursor` from the previous page.","required":false,"schema":{"type":"string"}},{"in":"query","name":"last","description":"Returns the last n results before the `before` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"before","description":"Returns results before this cursor. Use `startCursor` from the previous page.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations":{"post":{"summary":"Create a location","description":"Creates a single location.","tags":["Locations"],"operationId":"createLocation.post.v1/locations","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"Retrieve all locations","description":"Returns a list of locations associated with your account.","tags":["Locations"],"operationId":"getLocations.get.v1/locations","parameters":[{"in":"query","name":"id","required":false,"schema":{"type":"string"}},{"in":"query","name":"first","required":false,"schema":{"type":"string"}},{"in":"query","name":"after","required":false,"schema":{"type":"string"}},{"in":"query","name":"last","required":false,"schema":{"type":"string"}},{"in":"query","name":"before","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}/onboard/signature-packet":{"post":{"summary":"Create a location's signature packet","description":"Create a location's signature packet for onboarding. Must have the location data prefilled and documents uploaded.","tags":["Locations"],"operationId":"createOnboardLocationSignaturePacket.post.v1/locations/{id}/onboard/signature-packet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignaturePacket"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"delete":{"summary":"Delete a location's signature packet","description":"Delete a location's signature packet for onboarding. Must be done before creating a new one.","tags":["Locations"],"operationId":"deleteOnboardLocationSignaturePacket.delete.v1/locations/{id}/onboard/signature-packet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"Retrieve a location's signature packet","description":"Retrieve a location's signature packet for onboarding. Contains a link to sign the form.","tags":["Locations"],"operationId":"getOnboardLocationSignaturePacket.get.v1/locations/{id}/onboard/signature-packet","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignaturePacket"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/shipments":{"post":{"summary":"Request a shipment","description":"Requests one or more mail items to be shipped to the given address and recipient. Returns one entry per shipment created.","tags":["Shipments"],"operationId":"createShipments.post.v1/shipments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShipmentsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/tags":{"post":{"summary":"Create tags","description":"Creates one or more tags.","tags":["Tags"],"operationId":"createTags.post.v1/tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"delete":{"summary":"Delete tags","description":"Deletes one or more tags. Any deleted tags will be automatically removed from all mail items they are assigned to.","tags":["Tags"],"operationId":"deleteTags.delete.v1/tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTagsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"Lists all tags","description":"Returns a list of tags associated with your account.","tags":["Tags"],"operationId":"getTags.get.v1/tags","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTagsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/teams":{"post":{"summary":"Create teams","description":"Creates one or more teams.","tags":["Teams"],"operationId":"createTeams.post.v1/teams","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"delete":{"summary":"Delete teams","description":"Deletes one or more teams. Any deleted teams will be automatically removed from all mail items they are assigned to.","tags":["Teams"],"operationId":"deleteTeams.delete.v1/teams","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTeamsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"get":{"summary":"List all teams","description":"Returns a list of teams associated with your account. This does not include system-level teams like Admin or Read-Only.","tags":["Teams"],"operationId":"getTeams.get.v1/teams","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/deactivate":{"post":{"summary":"Deactivate a company","description":"Deactivates a company, changing its status to inactive.","tags":["Companies"],"operationId":"deactivateCompany.post.v1/companies/{id}/deactivate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}/deactivate":{"post":{"summary":"Deactivate a location","description":"Deactivates a location, changing its status to inactive.","tags":["Locations"],"operationId":"deactivateLocation.post.v1/locations/{id}/deactivate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}":{"get":{"summary":"Retrieve a company","description":"Returns a single company.","tags":["Companies"],"operationId":"getCompany.get.v1/companies/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]},"patch":{"summary":"Update a company","description":"Updates a single company. All fields are optional. Omitted fields are not updated.","tags":["Companies"],"operationId":"updateCompany.patch.v1/companies/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanyRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/filings":{"get":{"summary":"List all of a company's filings","description":"Returns the filings Stable has placed for the company, across all jurisdictions. The response has the same shape as the per-jurisdiction list.","tags":["Filings"],"operationId":"getCompanyFilings.get.v1/companies/{id}/filings","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"in":"query","name":"first","description":"Returns the first n results after the `after` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"after","description":"Returns results after this cursor. Use `endCursor` from the previous page.","required":false,"schema":{"type":"string"}},{"in":"query","name":"last","description":"Returns the last n results before the `before` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"before","description":"Returns results before this cursor. Use `startCursor` from the previous page.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types/{filingType}/filing-speeds/{filingSpeed}":{"get":{"summary":"Retrieve a filing type at a selected speed","description":"Returns the fields and fees required to submit this filing.","tags":["Filings"],"operationId":"getFilingSpeed.get.v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types/{filingType}/filing-speeds/{filingSpeed}","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"name":"jurisdiction","in":"path","required":true,"description":"Two-letter uppercase state code, such as `DE`.","schema":{"type":"string"}},{"name":"filingType","in":"path","required":true,"description":"A filing type slug, such as `certificate-of-good-standing`. Check the filing types list for this company and jurisdiction to see the list of valid slugs.","schema":{"type":"string"}},{"name":"filingSpeed","in":"path","required":true,"description":"One of `standard`, `expedited` or `rush`. Check the filing speeds list for this filing to see the valid speeds.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSpeedDetail"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"409":{"description":"Registered agent service is still being set up for this company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingConflictError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types/{filingType}/filing-speeds":{"get":{"summary":"List filing speeds","description":"Returns the speeds available for this filing type in this jurisdiction, including their fees.","tags":["Filings"],"operationId":"getFilingSpeeds.get.v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types/{filingType}/filing-speeds","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"name":"jurisdiction","in":"path","required":true,"description":"Two-letter uppercase state code, such as `DE`.","schema":{"type":"string"}},{"name":"filingType","in":"path","required":true,"description":"A filing type slug, such as `certificate-of-good-standing`. Check the filing types list for this company and jurisdiction to see the list of valid slugs.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFilingSpeedsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"409":{"description":"Registered agent service is still being set up for this company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingConflictError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types":{"get":{"summary":"List filing types","description":"Returns the filing types this company can file in this jurisdiction. An empty list means none are available.","tags":["Filings"],"operationId":"getFilingTypes.get.v1/companies/{id}/jurisdictions/{jurisdiction}/filing-types","parameters":[{"name":"id","in":"path","required":true,"description":"The company, from the companies list.","schema":{"type":"string"}},{"name":"jurisdiction","in":"path","required":true,"description":"Two-letter uppercase state code, such as `DE`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFilingTypesResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingBadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingNotFoundError"}}}},"409":{"description":"Registered agent service is still being set up for this company.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingConflictError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}":{"get":{"summary":"Retrieve a location","description":"Returns a single location.","tags":["Locations"],"operationId":"getLocation.get.v1/locations/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/mail-items/{id}":{"get":{"summary":"Retrieve a mail item","description":"Returns a single mail item.","tags":["Mail Items"],"operationId":"getMailItem.get.v1/mail-items/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailItem"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/mail-items":{"get":{"summary":"List all mail items","description":"Returns a list of mail items associated with your account.","tags":["Mail Items"],"operationId":"getMailItems.get.v1/mail-items","parameters":[{"in":"query","name":"search","description":"Returns mail items whose envelope or scanned contents match this text. Results are ordered by relevance instead of date. Up to 200 characters.","required":false,"schema":{"type":"string"}},{"in":"query","name":"id","description":"Returns only the mail items with these IDs. Repeat the parameter to pass more than one.","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"locationId","description":"Returns mail items at these locations. Repeat the parameter to pass more than one.","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"createdAt_gt","description":"Returns mail items created after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdAt_gte","description":"Returns mail items created on or after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdAt_lt","description":"Returns mail items created before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdAt_lte","description":"Returns mail items created on or before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.status","description":"Returns mail items by scan status. `processing`: a scan was requested and hasn't been uploaded yet. `completed`: the scan was uploaded. `none`: no scan was requested.","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.createdAt","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.createdAt_gt","description":"Returns mail items whose scan was requested after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.createdAt_gte","description":"Returns mail items whose scan was requested on or after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.createdAt_lt","description":"Returns mail items whose scan was requested before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"scan.createdAt_lte","description":"Returns mail items whose scan was requested on or before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"archived","description":"Returns archived mail items when `true` and unarchived mail items when `false`.","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isReturnedToSender","description":"Returns mail items that appear to be returned to sender when `true`, and mail items that don't when `false`.","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"check.status","description":"Returns mail items by check status. `none`: no checks were found in the mail item. `notRequested`: checks were found but no deposit was requested. `processing`, `completed`, and `failed` follow the deposit lifecycle. Repeat the parameter to match any of several statuses.","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"forward.status","description":"Returns mail items by forward status. `processing`: a forward was requested. `completed`: a shipping label has been created. The mail may not have shipped yet. `none`: no forward was requested.","required":false,"schema":{"type":"string"}},{"in":"query","name":"shred.status","description":"Returns mail items by shred status. `processing`: a shred was requested. `completed`: the mail item was shredded. `none`: no shred was requested.","required":false,"schema":{"type":"string"}},{"in":"query","name":"tagId","description":"Returns mail items with any of these tags. Repeat the parameter to pass more than one.","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"tagName","description":"Returns mail items with any of these tag names. Repeat the parameter to pass more than one.","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"in":"query","name":"clearAt_gt","description":"Returns mail items whose storage deadline is after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"clearAt_gte","description":"Returns mail items whose storage deadline is on or after this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"clearAt_lt","description":"Returns mail items whose storage deadline is before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"clearAt_lte","description":"Returns mail items whose storage deadline is on or before this date (ISO 8601).","required":false,"schema":{"type":"string"}},{"in":"query","name":"first","description":"Returns the first n results after the `after` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"after","description":"Returns results after this cursor. Use `endCursor` from the previous page.","required":false,"schema":{"type":"string"}},{"in":"query","name":"last","description":"Returns the last n results before the `before` cursor. Up to 500, defaults to 100.","required":false,"schema":{"type":"integer"}},{"in":"query","name":"before","description":"Returns results before this cursor. Use `startCursor` from the previous page.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailItemsConnection"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/shipping-methods":{"post":{"summary":"List available shipping methods","description":"Returns the shipping methods available for the given mail items and destination, grouped by shipment.","tags":["Shipments"],"operationId":"getShippingMethods.post.v1/shipping-methods","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingMethodsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShippingMethodsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}/onboard/session":{"post":{"summary":"Onboard a location","description":"Generate a USPS1583 Shared Session to facilitate onboarding your location.","tags":["Locations"],"operationId":"onboardLocation.post.v1/locations/{id}/onboard/session","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USPS1583SharedSession"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}/onboard/prefill":{"post":{"summary":"Onboard a location - Prefill","description":"Prefill a location's onboarding data with customer information and return a shared session.","tags":["Locations"],"operationId":"onboardLocationPrefill.post.v1/locations/{id}/onboard/prefill","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardLocationPrefillBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/USPS1583SharedSession"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/locations/{id}/onboard/upload-urls":{"post":{"summary":"Generate signed upload URLs for onboarding documents","description":"Generate pre-signed S3 URLs for uploading your onboarding documents.","tags":["Locations"],"operationId":"onboardLocationUploadUrls.post./v1/locations/{id}/onboard/upload-urls","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardLocationUploadUrlsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardLocationUploadUrlsResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/teams/{id}":{"put":{"summary":"Rename a team","description":"Renames a single team.","tags":["Teams"],"operationId":"renameTeam.put.v1/teams/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameTeamRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameTeamResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/mail-items/tags":{"post":{"summary":"Assign or remove tags on mail items","description":"Assigns or removes tags on one or more mail items.","tags":["Tags"],"operationId":"setMailItemsTags.post.v1/mail-items/tags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetMailItemsTagsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/mail-items/teams":{"post":{"summary":"Assign or remove teams on mail items","description":"Assigns or removes teams on one or more mail items.","tags":["Teams"],"operationId":"setMailItemsTeams.post.v1/mail-items/teams","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetMailItemsTeamsRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}},"/v1/tags/{id}":{"put":{"summary":"Update a tag","description":"Updates a single tag.","tags":["Tags"],"operationId":"updateTag.put.v1/tags/{id}","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagRequestBody"}}},"description":"Body required in the request","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagResponseBody"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalError"}}}}},"security":[{"x-api-key":[]}]}}},"servers":[{"url":"https://api.usestable.com","description":"Production"},{"url":"https://api.dev.usestable.com","description":"Development"}],"components":{"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header"}},"schemas":{"DestinationAccountType":{"enum":["electronic","mailIn"],"title":"DestinationAccountType","type":"string"},"CheckDestinationAccount":{"properties":{"id":{"title":"CheckDestinationAccount.id","description":"The unique ID of the account the check was deposited into.","type":"string"},"name":{"title":"CheckDestinationAccount.name","description":"The display name of the account the check was deposited into.","type":"string"},"type":{"$ref":"#/components/schemas/DestinationAccountType"},"last4":{"title":"CheckDestinationAccount.last4","description":"The last 4 digits of the destination account number.","type":"string"}},"required":["id","name","type","last4"],"additionalProperties":false,"title":"CheckDestinationAccount","type":"object"},"CheckImage":{"properties":{"type":{"enum":["front_full","front_cropped"],"title":"CheckImage.type","description":"The type of image","type":"string"},"url":{"title":"CheckImage.url","description":"A signed URL to the image","type":"string"}},"required":["type","url"],"additionalProperties":false,"title":"CheckImage","description":"An image associated with a Check.","type":"object"},"Check":{"properties":{"id":{"title":"Check.id","type":"string"},"amount":{"title":"Check.amount","type":"number"},"currency":{"title":"Check.currency","type":"string"},"checkNumber":{"title":"Check.checkNumber","type":"string"},"createdAt":{"title":"Check.createdAt","type":"string"},"mailItemId":{"title":"Check.mailItemId","type":"string"},"payer":{"title":"Check.payer","type":"string"},"payee":{"title":"Check.payee","type":"string"},"memo":{"title":"Check.memo","type":"string"},"issueDate":{"title":"Check.issueDate","type":"string"},"voidDate":{"title":"Check.voidDate","description":"The date the check will become void, based on information printed on the check (e.g. \"void after 90 days\").","type":"string"},"accountNumber":{"title":"Check.accountNumber","type":"string"},"routingNumber":{"title":"Check.routingNumber","type":"string"},"returnReason":{"title":"Check.returnReason","description":"The reason the check was returned (e.g. \"STOP PAYMENT\", \"CLOSED ACCOUNT\", \"DUPLICATE PRESENTMENT\", \"NOT SUFFICIENT FUNDS\", \"REFER TO MAKER\").","type":"string"},"status":{"$ref":"#/components/schemas/CheckStatus"},"destinationAccount":{"title":"Check.destinationAccount","description":"The account the deposit was requested to; null when there is no request.","allOf":[{"$ref":"#/components/schemas/CheckDestinationAccount"}]},"statusTransitions":{"properties":{"processing":{"title":"Check.statusTransitions.processing","type":"string"},"completed":{"title":"Check.statusTransitions.completed","type":"string"},"failed":{"title":"Check.statusTransitions.failed","type":"string"}},"additionalProperties":false,"title":"Check.statusTransitions","type":"object"},"failureDetails":{"properties":{"description":{"title":"Check.failureDetails.description","type":"string"},"code":{"title":"Check.failureDetails.code","type":"string"}},"required":["description","code"],"additionalProperties":false,"title":"Check.failureDetails","type":"object"},"images":{"items":{"$ref":"#/components/schemas/CheckImage"},"title":"Check.images","description":"Images associated with this check (e.g. full-page scan, cropped check)","type":"array"}},"required":["id","amount","currency","createdAt","mailItemId","status","statusTransitions","images"],"additionalProperties":false,"title":"Check","description":"A Check we've transcribed from inside a MailItem.","type":"object"},"CheckStatus":{"enum":["notRequested","processing","completed","failed"],"title":"CheckStatus","type":"string"},"CompaniesConnection":{"properties":{"edges":{"items":{"properties":{"cursor":{"title":"CompaniesConnection.edges.[].cursor","type":"string"},"node":{"$ref":"#/components/schemas/Company"}},"required":["cursor","node"],"additionalProperties":false,"title":"CompaniesConnection.edges.[]","type":"object"},"title":"CompaniesConnection.edges","type":"array"},"pageInfo":{"properties":{"endCursor":{"title":"CompaniesConnection.pageInfo.endCursor","type":"string"},"hasNextPage":{"title":"CompaniesConnection.pageInfo.hasNextPage","type":"boolean"},"hasPreviousPage":{"title":"CompaniesConnection.pageInfo.hasPreviousPage","type":"boolean"},"startCursor":{"title":"CompaniesConnection.pageInfo.startCursor","type":"string"}},"required":["hasNextPage","hasPreviousPage"],"additionalProperties":false,"title":"CompaniesConnection.pageInfo","type":"object"},"totalCount":{"title":"CompaniesConnection.totalCount","type":"number"}},"required":["edges","pageInfo","totalCount"],"additionalProperties":false,"title":"CompaniesConnection","type":"object"},"CompanyJurisdiction":{"properties":{"locationCode":{"$ref":"#/components/schemas/State"},"formation":{"title":"CompanyJurisdiction.formation","type":"boolean"}},"required":["locationCode","formation"],"additionalProperties":false,"title":"CompanyJurisdiction","type":"object"},"Company":{"properties":{"id":{"title":"Company.id","type":"string"},"status":{"$ref":"#/components/schemas/CompanyStatus"},"legalName":{"title":"Company.legalName","type":"string"},"entityType":{"title":"Company.entityType","description":"The entity type, or null if not set.","allOf":[{"$ref":"#/components/schemas/CompanyEntityType"}]},"ein":{"title":"Company.ein","description":"The Employer Identification Number, or null if not set.","type":"string"},"jurisdictions":{"items":{"$ref":"#/components/schemas/CompanyJurisdiction"},"title":"Company.jurisdictions","type":"array"},"formationDate":{"title":"Company.formationDate","description":"The formation date in YYYY-MM-DD format, or null if not set.","type":"string","example":"2024-01-15"}},"required":["id","status","legalName","jurisdictions"],"additionalProperties":false,"title":"Company","type":"object"},"State":{"enum":["AK","AL","AR","AZ","CA","CO","CT","DC","DE","FL","GA","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VA","VT","WA","WI","WV","WY"],"title":"State","type":"string"},"CompanyStatus":{"enum":["active","inactive"],"title":"CompanyStatus","type":"string"},"CompanyEntityType":{"enum":["association","attorney-for-bar","benefit-corporation","benefit-llc","benefit-professional-corporation","close-corporation","close-limited-liability-company","close-professional-corporation","cooperative","corporation-sole","corporation","doing-business-as-name","exempt-nonstock-corporation","general-partnership","individual","limited-liability-company","limited-liability-limited-partnership","limited-liability-partnership","limited-partnership","low-profit-limited-liability-company","massachusetts-trust","mutual-benefit-enterprise","mutual-benefit-nonprofit-corporation","nonprofit-corporation","nonprofit-limited-liability-company","personal-attorney","professional-corporation","professional-limited-liability-company","professional-limited-liability-limited-partnership","professional-limited-liability-partnership","professional-limited-partnership","public-benefit-nonprofit-corporation","religious-nonprofit-corporation","series-limited-liability-company","series-professional-limited-liability-company","sole-proprietorship","sustainable-business-corporation","trust"],"title":"CompanyEntityType","type":"string"},"CreateCompanyRequestBody":{"properties":{"legalName":{"title":"CreateCompanyRequestBody.legalName","description":"Legal name of the company.","type":"string","example":"Ada's Apples LLC"},"entityType":{"title":"CreateCompanyRequestBody.entityType","description":"Entity type of the company.","allOf":[{"$ref":"#/components/schemas/CompanyEntityType"}]},"jurisdictions":{"items":{"$ref":"#/components/schemas/State"},"title":"CreateCompanyRequestBody.jurisdictions","description":"List of states in which the company operates.","type":"array"},"formationJurisdiction":{"title":"CreateCompanyRequestBody.formationJurisdiction","description":"State in which the company was formed. Must be included in `jurisdictions`.","allOf":[{"$ref":"#/components/schemas/State"}]},"formationDate":{"title":"CreateCompanyRequestBody.formationDate","description":"Date the company was formed, in YYYY-MM-DD format.","type":"string","example":"2024-01-15"},"ein":{"title":"CreateCompanyRequestBody.ein","description":"Employer Identification Number in the format xx-xxxxxxx.","type":"string","example":"12-3456789"}},"required":["legalName","entityType","jurisdictions","formationJurisdiction"],"additionalProperties":false,"title":"CreateCompanyRequestBody","type":"object"},"PlatformPrefillRecipients":{"properties":{"business":{"items":{"$ref":"#/components/schemas/PlatformPrefillBusinessRecipients"},"title":"PlatformPrefillRecipients.business","description":"Business recipients for the created location. If provided, the top level `business` field is also required.","type":"array"},"individual":{"items":{"$ref":"#/components/schemas/PlatformPrefillIndividualRecipients"},"title":"PlatformPrefillRecipients.individual","description":"Individual recipients for the created location. At least one individual recipient is required.","type":"array"}},"required":["individual"],"additionalProperties":false,"title":"PlatformPrefillRecipients","type":"object"},"PlatformPrefillIndividualRecipients":{"properties":{"firstName":{"title":"PlatformPrefillIndividualRecipients.firstName","description":"First name of the individual recipient","type":"string","example":"Ada"},"lastName":{"title":"PlatformPrefillIndividualRecipients.lastName","description":"Last name of the individual recipient","type":"string","example":"Lovelace"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"PlatformPrefillIndividualRecipients","type":"object"},"PlatformPrefillBusiness":{"properties":{"legalBusinessName":{"title":"PlatformPrefillBusiness.legalBusinessName","description":"Legal name of the business","type":"string","example":"Ada's Apples"},"placeOfRegistration":{"title":"PlatformPrefillBusiness.placeOfRegistration","description":"If the business is in the United States, then \"county, state\" is required -- otherwise just \"country\".","type":"string","example":"Kent County, DE"},"businessType":{"title":"PlatformPrefillBusiness.businessType","description":"The NAICS definition of the business.\nLearn more: https://www.census.gov/naics/?58967?yearbck=2022","type":"string","example":"Agriculture"}},"required":["legalBusinessName","placeOfRegistration","businessType"],"additionalProperties":false,"title":"PlatformPrefillBusiness","type":"object"},"PlatformPrefillBusinessRecipients":{"properties":{"name":{"title":"PlatformPrefillBusinessRecipients.name","description":"Name of the business recipient","type":"string","example":"Ada's Apples"}},"required":["name"],"additionalProperties":false,"title":"PlatformPrefillBusinessRecipients","type":"object"},"CreateLocationRequestBody":{"properties":{"locationCode":{"title":"CreateLocationRequestBody.locationCode","description":"Identifies the location to create. Either:\n- A CMRA airport code (IATA-style, e.g. \"ATL3\") for a CMRA location, or\n- A 2-letter US state or territory abbreviation (e.g. \"WY\") for a registered\n  agent (RA) location.","allOf":[{"$ref":"#/components/schemas/LocationCode"}]},"autoScan":{"title":"CreateLocationRequestBody.autoScan","description":"Whether incoming mail should be auto-scanned. Defaults to `true`. For RA\nlocations, only `true` is permitted.","type":"boolean"},"metadata":{"title":"CreateLocationRequestBody.metadata","description":"Arbitrary key/value pairs to attach to the location. Values must be strings or numbers.","type":"object"},"platformPrefill":{"title":"CreateLocationRequestBody.platformPrefill","description":"Pre-fill data for the new location. Only allowed for CMRA locations;\nnot allowed for RA locations.","allOf":[{"$ref":"#/components/schemas/PlatformPrefill"}]},"companyId":{"title":"CreateLocationRequestBody.companyId","description":"UUID of an existing company. Required for RA locations. Not allowed for CMRA locations.","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"additionalInformation":{"title":"CreateLocationRequestBody.additionalInformation","description":"Additional information required for certain RA jurisdictions (e.g. Wyoming).\nOnly allowed for RA locations; not allowed for CMRA locations.","allOf":[{"$ref":"#/components/schemas/AdditionalRegisteredAgentInformation"}]}},"required":["locationCode"],"additionalProperties":false,"title":"CreateLocationRequestBody","type":"object"},"LocationCode":{"enum":["ATL3","AUS2","BHM1","BNA1","BOS1","BWI1","CHS1","CLT1","CMH1","CRW1","CYS1","DCA1","DCA2","DEN1","DFW2","DSM1","DTW1","EWR1","FSD1","HPN1","IAH1","ILG1","ILG2","IND1","LAS1","LAX1","LGA1","MCI1","MDW1","MHT1","MIA1","MSP1","MSY1","OMA1","PHL1","PHX1","SDF1","SEA1","SFO1","SLC1","AK","AL","AR","AZ","CA","CO","CT","DC","DE","FL","GA","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","RI","SC","SD","TN","TX","UT","VA","VT","WA","WI","WV","WY"],"title":"LocationCode","type":"string"},"PlatformPrefill":{"properties":{"business":{"title":"PlatformPrefill.business","description":"Business information for the created location.","allOf":[{"$ref":"#/components/schemas/PlatformPrefillBusiness"}]},"recipients":{"title":"PlatformPrefill.recipients","description":"Recipients for the created location.","allOf":[{"$ref":"#/components/schemas/PlatformPrefillRecipients"}]}},"required":["recipients"],"additionalProperties":false,"title":"PlatformPrefill","type":"object"},"AdditionalRegisteredAgentInformation":{"properties":{"managementType":{"title":"AdditionalRegisteredAgentInformation.managementType","description":"Management type for the entity (e.g. \"Member Managed\" or \"Manager Managed\")","type":"string","example":"Member Managed"},"official":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.official.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.official.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.official","type":"object"},"officialDirector":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialDirector.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialDirector.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialDirector","type":"object"},"officialManager":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialManager.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialManager.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialManager","type":"object"},"officialMember":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialMember.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialMember.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialMember","type":"object"},"officialPartner":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialPartner.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialPartner.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialPartner","type":"object"},"officialPresident":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialPresident.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialPresident.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialPresident","type":"object"},"officialSecretary":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialSecretary.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialSecretary.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialSecretary","type":"object"},"officialTreasurer":{"properties":{"firstName":{"title":"AdditionalRegisteredAgentInformation.officialTreasurer.firstName","description":"First name","type":"string","example":"John"},"lastName":{"title":"AdditionalRegisteredAgentInformation.officialTreasurer.lastName","description":"Last name","type":"string","example":"Doe"}},"required":["firstName","lastName"],"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation.officialTreasurer","type":"object"}},"additionalProperties":false,"title":"AdditionalRegisteredAgentInformation","type":"object"},"CreateTagsRequestBody":{"properties":{"tags":{"items":{"properties":{"name":{"title":"CreateTagsRequestBody.tags.[].name","type":"string"}},"required":["name"],"additionalProperties":false,"title":"CreateTagsRequestBody.tags.[]","type":"object"},"title":"CreateTagsRequestBody.tags","type":"array"}},"required":["tags"],"additionalProperties":false,"title":"CreateTagsRequestBody","type":"object"},"CreateTagsResponseBody":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/Tag"},"title":"CreateTagsResponseBody.tags","type":"array"}},"required":["tags"],"additionalProperties":false,"title":"CreateTagsResponseBody","type":"object"},"DeleteTagsRequestBody":{"properties":{"tags":{"items":{"properties":{"id":{"title":"DeleteTagsRequestBody.tags.[].id","type":"string"}},"required":["id"],"additionalProperties":false,"title":"DeleteTagsRequestBody.tags.[]","type":"object"},"title":"DeleteTagsRequestBody.tags","type":"array"}},"required":["tags"],"additionalProperties":false,"title":"DeleteTagsRequestBody","type":"object"},"DataExtractionResult":{"properties":{"id":{"title":"DataExtractionResult.id","description":"The ID of this data extraction result.","type":"string"},"extractor":{"title":"DataExtractionResult.extractor","description":"The extractor that produced this result.","allOf":[{"$ref":"#/components/schemas/Extractor"}]},"status":{"title":"DataExtractionResult.status","description":"The status of the extraction.","allOf":[{"$ref":"#/components/schemas/DataExtractionStatus"}]},"succeededAt":{"title":"DataExtractionResult.succeededAt","description":"When the extraction succeeded, or null if not yet succeeded.","type":"string"},"failedAt":{"title":"DataExtractionResult.failedAt","description":"When the extraction failed, or null if not failed.","type":"string"},"deletedAt":{"title":"DataExtractionResult.deletedAt","description":"When the result was deleted, or null if not deleted.","type":"string"},"extractedData":{"items":{},"title":"DataExtractionResult.extractedData","description":"The extracted data. An empty array indicates no data was extracted for this document.","type":"array"}},"required":["id","extractor","status","extractedData"],"additionalProperties":false,"title":"DataExtractionResult","type":"object"},"Extractor":{"properties":{"id":{"title":"Extractor.id","description":"The ID of the extractor.","type":"string"},"name":{"title":"Extractor.name","description":"The name of the extractor.","type":"string"}},"required":["id","name"],"additionalProperties":false,"title":"Extractor","type":"object"},"DataExtractionStatus":{"enum":["pending","succeeded","failed","deleted"],"title":"DataExtractionStatus","type":"string"},"FilingStatus":{"enum":["inProgress","complete","cancelled"],"title":"FilingStatus","type":"string"},"FilingFieldType":{"enum":["string","number","boolean","object"],"title":"FilingFieldType","type":"string"},"FilingFieldFormat":{"enum":["email","phone","date"],"title":"FilingFieldFormat","type":"string"},"FilingSpeed":{"enum":["standard","expedited","rush"],"title":"FilingSpeed","type":"string"},"FilingType":{"enum":["amendment","beneficial-ownership-information-report","certificate-of-good-standing","certified-copy","change-registered-agent","compliance","dissolve-a-company","dissolve-a-company-long-form","ein-tax-id","form-a-company","initial-report","plain-copy","register-a-company","registered-agent-resignation","s-corp","trade-name","withdraw-a-company"],"title":"FilingType","type":"string"},"FilingTypeOffering":{"properties":{"filingType":{"title":"FilingTypeOffering.filingType","description":"The filing type. Not every jurisdiction supports every filing type, so this list includes the\nones available for this company in this jurisdiction.","example":"form-a-company","allOf":[{"$ref":"#/components/schemas/FilingType"}]},"name":{"title":"FilingTypeOffering.name","description":"The filing type's display name.","type":"string","example":"Form a Company"}},"required":["filingType","name"],"additionalProperties":false,"title":"FilingTypeOffering","type":"object"},"FilingSpeedOption":{"properties":{"filingSpeed":{"title":"FilingSpeedOption.filingSpeed","description":"One of `standard`, `expedited` or `rush`. `standard` is always offered. Whether `expedited`\nand `rush` are offered depends on the agency and the filing type.\n\nThese speeds describe Stable's processing speed and may not match the names the agency uses\nfor its service tiers. A faster speed can mean we purchase an expedited option from the agency.","example":"standard","allOf":[{"$ref":"#/components/schemas/FilingSpeed"}]},"name":{"title":"FilingSpeedOption.name","description":"The name this option is sold under.","type":"string","example":"Standard"},"agencyName":{"title":"FilingSpeedOption.agencyName","description":"The agency that processes the filing.","type":"string","example":"Division of Corporations"},"description":{"title":"FilingSpeedOption.description","description":"The name of the form being filed.","type":"string","example":"Certificate of Incorporation"},"filingFee":{"title":"FilingSpeedOption.filingFee","description":"Stable's fee, in cents.","type":"number","example":7500},"agencyFee":{"title":"FilingSpeedOption.agencyFee","description":"The agency's fee, in cents.","type":"number","example":10900}},"required":["filingSpeed","name","agencyName","description","filingFee","agencyFee"],"additionalProperties":false,"title":"FilingSpeedOption","type":"object"},"FilingSpeedDetail":{"properties":{"filingSpeed":{"title":"FilingSpeedDetail.filingSpeed","description":"One of `standard`, `expedited` or `rush`. See the filing speeds list for how these map onto\nwhat each jurisdiction offers.","example":"standard","allOf":[{"$ref":"#/components/schemas/FilingSpeed"}]},"name":{"title":"FilingSpeedDetail.name","description":"The name this option is sold under.","type":"string","example":"Standard"},"agencyName":{"title":"FilingSpeedDetail.agencyName","description":"The agency that processes the filing.","type":"string","example":"Division of Corporations"},"description":{"title":"FilingSpeedDetail.description","description":"The name of the form being filed.","type":"string","example":"Certificate of Incorporation"},"filingFee":{"title":"FilingSpeedDetail.filingFee","description":"Stable's fee, in cents.","type":"number","example":7500},"agencyFee":{"title":"FilingSpeedDetail.agencyFee","description":"The agency's fee, in cents.","type":"number","example":10900},"fields":{"items":{"$ref":"#/components/schemas/FilingField"},"title":"FilingSpeedDetail.fields","description":"The fields to send values for when placing this filing. An empty array means the filing\nneeds no input beyond the company itself.","type":"array"}},"required":["filingSpeed","name","agencyName","description","filingFee","agencyFee","fields"],"additionalProperties":false,"title":"FilingSpeedDetail","type":"object"},"FilingFieldOption":{"properties":{"label":{"title":"FilingFieldOption.label","description":"A label to display for the option.","type":"string","example":"Delaware"},"value":{"title":"FilingFieldOption.value","description":"The value to be included in `values` when submitting the filing.","type":"string","example":"DE"}},"required":["label","value"],"additionalProperties":false,"title":"FilingFieldOption","type":"object"},"FilingField":{"properties":{"key":{"title":"FilingField.key","description":"The key to use for this field in the `values` object.","type":"string","example":"authorized_shares"},"label":{"title":"FilingField.label","description":"Display this as the field's label when rendering the field in a UI.","type":"string","example":"Authorized shares"},"type":{"title":"FilingField.type","description":"One of `string`, `number`, `boolean` or `object`. An `object` field has its own sub-fields in\n`fields`. Render them the same way, recursively.","example":"number","allOf":[{"$ref":"#/components/schemas/FilingFieldType"}]},"required":{"title":"FilingField.required","description":"Whether a value must be supplied for this field.","type":"boolean","example":true},"format":{"title":"FilingField.format","description":"One of `email`, `phone` or `date`, where the field expects a particular shape of string. A\n`date` must be `YYYY-MM-DD`. A `phone` can contain digits, spaces and `( ) . + -`. Null when\nthe field has no specific format.","example":"email","allOf":[{"$ref":"#/components/schemas/FilingFieldFormat"}]},"description":{"title":"FilingField.description","description":"Hint text that can be displayed alongside the field and its label.","type":"string","example":"The number of shares created when you formed your corporation."},"repeatable":{"title":"FilingField.repeatable","description":"Whether the field accepts an array of values rather than one.","type":"boolean","example":true},"options":{"items":{"$ref":"#/components/schemas/FilingFieldOption"},"title":"FilingField.options","description":"The values this field accepts. Null when the field is not limited to a list.","type":"array"},"pattern":{"title":"FilingField.pattern","description":"A regular expression the value must match.","type":"string"},"fields":{"items":{"$ref":"#/components/schemas/FilingField"},"title":"FilingField.fields","description":"The sub-fields of an `object` field. Null for other types.","type":"array"}},"required":["key","label","type","required","repeatable"],"additionalProperties":false,"title":"FilingField","description":"Optional keys are returned as `null` when they are not relevant for the field.","type":"object"},"Filing":{"properties":{"id":{"title":"Filing.id","description":"The filing's ID.","type":"string","example":"6c4d7272-7390-4b38-8c9f-fecedfc33d3c"},"name":{"title":"Filing.name","description":"The filing's display name.","type":"string","example":"Delaware Form a Company Filing"},"status":{"title":"Filing.status","description":"One of `inProgress`, `complete` or `cancelled`.","example":"inProgress","allOf":[{"$ref":"#/components/schemas/FilingStatus"}]},"jurisdiction":{"title":"Filing.jurisdiction","description":"Two-letter uppercase state code for the jurisdiction the filing was placed in. Always present,\nand `null` when the filing has no jurisdiction.","type":"string","example":"DE"},"createdAt":{"title":"Filing.createdAt","description":"When the filing was placed, as an ISO 8601 timestamp in UTC.","type":"string","example":"2026-09-16T18:10:51.350Z"}},"required":["id","name","status","createdAt"],"additionalProperties":false,"title":"Filing","type":"object"},"GetFilingTypesResponseBody":{"properties":{"filingTypes":{"items":{"$ref":"#/components/schemas/FilingTypeOffering"},"title":"GetFilingTypesResponseBody.filingTypes","description":"The filing types this company can file in this jurisdiction. An empty array means none are\navailable, which is a valid response.","type":"array"}},"required":["filingTypes"],"additionalProperties":false,"title":"GetFilingTypesResponseBody","type":"object"},"GetFilingSpeedsResponseBody":{"properties":{"filingSpeeds":{"items":{"$ref":"#/components/schemas/FilingSpeedOption"},"title":"GetFilingSpeedsResponseBody.filingSpeeds","description":"The speeds available for this filing type in this jurisdiction.","type":"array"}},"required":["filingSpeeds"],"additionalProperties":false,"title":"GetFilingSpeedsResponseBody","type":"object"},"CreateFilingRequestBody":{"properties":{"filingType":{"title":"CreateFilingRequestBody.filingType","description":"The filing to place. Get the filing types available for this company in this jurisdiction\nfrom the filing types endpoint.","example":"form-a-company","allOf":[{"$ref":"#/components/schemas/FilingType"}]},"filingSpeed":{"title":"CreateFilingRequestBody.filingSpeed","description":"The speed tier to place the filing at, from the filing speeds list for this filing. Ordering a\nfiling at a speed that is not offered results in a 404.","example":"standard","allOf":[{"$ref":"#/components/schemas/FilingSpeed"}]},"filingContact":{"properties":{"email":{"title":"CreateFilingRequestBody.filingContact.email","type":"string"}},"required":["email"],"additionalProperties":false,"title":"CreateFilingRequestBody.filingContact","description":"The person Stable should contact if there's a problem with this filing.","type":"object"},"values":{"title":"CreateFilingRequestBody.values","description":"The values for this filing's fields, keyed by each field's `key`. For an `object` field, send\na nested object with the same shape. The filing speed endpoint lists the fields.","type":"object"}},"required":["filingType","filingSpeed","filingContact","values"],"additionalProperties":false,"title":"CreateFilingRequestBody","type":"object"},"FilingsConnection":{"properties":{"edges":{"items":{"$ref":"#/components/schemas/FilingEdge"},"title":"FilingsConnection.edges","description":"The filings on this page, newest first.","type":"array"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"},"totalCount":{"title":"FilingsConnection.totalCount","description":"How many filings match in total, before paging.","type":"number","example":3}},"required":["edges","pageInfo","totalCount"],"additionalProperties":false,"title":"FilingsConnection","type":"object"},"FilingEdge":{"properties":{"cursor":{"title":"FilingEdge.cursor","description":"This filing's position in the list. Pass it back as `after` or `before` to page from here.","type":"string","example":"MA=="},"node":{"$ref":"#/components/schemas/Filing"}},"required":["cursor","node"],"additionalProperties":false,"title":"FilingEdge","type":"object"},"PageInfo":{"properties":{"hasNextPage":{"title":"PageInfo.hasNextPage","description":"Whether more filings follow this page.","type":"boolean","example":true},"hasPreviousPage":{"title":"PageInfo.hasPreviousPage","description":"Whether more filings precede this page.","type":"boolean","example":false},"startCursor":{"title":"PageInfo.startCursor","description":"When paginating backwards, the cursor to pass as `before`. Null when the page is empty.","type":"string","example":"MA=="},"endCursor":{"title":"PageInfo.endCursor","description":"When paginating forwards, the cursor to pass as `after`. Null when the page is empty.","type":"string","example":"Mg=="}},"required":["hasNextPage","hasPreviousPage"],"additionalProperties":false,"title":"PageInfo","description":"Every key is present on every page. `startCursor` and `endCursor` come back as `null` on an\nempty page.","type":"object"},"BadRequestError":{"properties":{"message":{"title":"BadRequestError.message","enum":["Bad Request"],"type":"string"}},"required":["message"],"additionalProperties":false,"title":"BadRequestError","type":"object"},"NotFoundError":{"properties":{"message":{"title":"NotFoundError.message","enum":["Not Found"],"type":"string"}},"required":["message"],"additionalProperties":false,"title":"NotFoundError","type":"object"},"Forbidden":{"properties":{"message":{"title":"Forbidden.message","enum":["Forbidden"],"type":"string"}},"required":["message"],"additionalProperties":false,"title":"Forbidden","type":"object"},"ConflictError":{"properties":{"message":{"title":"ConflictError.message","description":"Names the mail items that blocked the request and why.","type":"string","example":"Cannot forward mail item 0a1b2c: it already has a forward request (processing)."}},"required":["message"],"additionalProperties":false,"title":"ConflictError","type":"object"},"FilingBadRequestCode":{"enum":["VALIDATION_ERROR","IDEMPOTENCY_KEY_REQUIRED","MISSING_ENTITY_INFORMATION","NO_REGISTERED_AGENT"],"title":"FilingBadRequestCode","type":"string"},"FilingNotFoundCode":{"enum":["COMPANY_NOT_FOUND","NOT_IN_JURISDICTION","FILING_NOT_AVAILABLE","FILING_SPEED_NOT_AVAILABLE"],"title":"FilingNotFoundCode","type":"string"},"FilingConflictCode":{"enum":["REGISTERED_AGENT_PENDING","IDEMPOTENCY_CONFLICT"],"title":"FilingConflictCode","type":"string"},"FilingPaymentRequiredCode":{"title":"FilingPaymentRequiredCode","enum":["FILING_PAYMENT_ERROR"],"type":"string"},"FilingBadRequestError":{"properties":{"code":{"title":"FilingBadRequestError.code","description":"`VALIDATION_ERROR`: the request did not match the schema.\n\n`IDEMPOTENCY_KEY_REQUIRED`: send an Idempotency-Key of 1 to 128 letters, digits, hyphens or\nunderscores.\n\n`MISSING_ENTITY_INFORMATION`: the company is missing something the filing needs, such as its\nentity type. Update the company, then retry.\n\n`NO_REGISTERED_AGENT`: the company has no registered agent in this jurisdiction.\n\nSome errors don't include a code yet. Read `message` when `code` is missing.","example":"VALIDATION_ERROR","allOf":[{"$ref":"#/components/schemas/FilingBadRequestCode"}]},"message":{"title":"FilingBadRequestError.message","type":"string","example":"filingSpeed must be one of: standard, expedited, rush"}},"required":["message"],"additionalProperties":false,"title":"FilingBadRequestError","type":"object"},"FilingNotFoundError":{"properties":{"code":{"title":"FilingNotFoundError.code","description":"`COMPANY_NOT_FOUND`: no company with that id on your account.\n\n`NOT_IN_JURISDICTION`: the company does not operate in this state.\n\n`FILING_NOT_AVAILABLE`: this filing type is not offered for this company here. The filing\ntypes list has the ones that are.\n\n`FILING_SPEED_NOT_AVAILABLE`: the filing is offered, but not at that speed. The filing speeds\nlist has the ones it is.","example":"FILING_SPEED_NOT_AVAILABLE","allOf":[{"$ref":"#/components/schemas/FilingNotFoundCode"}]},"message":{"title":"FilingNotFoundError.message","type":"string","example":"This filing is not offered at rush speed here. Available: standard, expedited."}},"required":["message"],"additionalProperties":false,"title":"FilingNotFoundError","type":"object"},"FilingConflictError":{"properties":{"code":{"title":"FilingConflictError.code","description":"`REGISTERED_AGENT_PENDING`: registered agent service is still being set up for this company.\nRetry once it is active.\n\n`IDEMPOTENCY_CONFLICT`: this Idempotency-Key was already used on this company for a different\nfiling. Retrying the same filing returns the original; use a fresh key to place a different one.","example":"IDEMPOTENCY_CONFLICT","allOf":[{"$ref":"#/components/schemas/FilingConflictCode"}]},"message":{"title":"FilingConflictError.message","type":"string","example":"A request with this idempotency key already exists."}},"required":["message"],"additionalProperties":false,"title":"FilingConflictError","type":"object"},"FilingPaymentRequiredError":{"properties":{"code":{"title":"FilingPaymentRequiredError.code","description":"`FILING_PAYMENT_ERROR`: the payment was declined, so nothing was filed. Fix the payment method\nand send the request again with the same Idempotency-Key.","example":"FILING_PAYMENT_ERROR","allOf":[{"$ref":"#/components/schemas/FilingPaymentRequiredCode"}]},"message":{"title":"FilingPaymentRequiredError.message","type":"string","example":"Your card was declined."}},"required":["message"],"additionalProperties":false,"title":"FilingPaymentRequiredError","type":"object"},"InternalError":{"properties":{"message":{"title":"InternalError.message","enum":["Internal Error"],"type":"string"}},"required":["message"],"additionalProperties":false,"title":"InternalError","type":"object"},"GetTagsResponseBody":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/Tag"},"title":"GetTagsResponseBody.tags","type":"array"}},"required":["tags"],"additionalProperties":false,"title":"GetTagsResponseBody","type":"object"},"Location":{"properties":{"id":{"title":"Location.id","type":"string"},"status":{"$ref":"#/components/schemas/LocationStatus"},"address":{"properties":{"line1":{"title":"Location.address.line1","type":"string"},"line2":{"title":"Location.address.line2","type":"string"},"city":{"title":"Location.address.city","type":"string"},"state":{"title":"Location.address.state","type":"string"},"postalCode":{"title":"Location.address.postalCode","type":"string"}},"required":["line1","line2","city","state","postalCode"],"additionalProperties":false,"title":"Location.address","type":"object"},"type":{"$ref":"#/components/schemas/LocationType"},"onboarding":{"properties":{"status":{"$ref":"#/components/schemas/OnboardingStatus"}},"required":["status"],"additionalProperties":false,"title":"Location.onboarding","type":"object"},"metadata":{"title":"Location.metadata","type":"object"}},"required":["id","status","address","type","onboarding","metadata"],"additionalProperties":false,"title":"Location","type":"object"},"LocationStatus":{"enum":["active","inactive"],"title":"LocationStatus","type":"string"},"LocationType":{"enum":["cmra","registeredAgent"],"title":"LocationType","type":"string"},"OnboardingStatus":{"enum":["authorize","sign","verify","complete"],"title":"OnboardingStatus","type":"string"},"LocationsConnection":{"properties":{"edges":{"items":{"properties":{"cursor":{"title":"LocationsConnection.edges.[].cursor","type":"string"},"node":{"$ref":"#/components/schemas/Location"}},"required":["cursor","node"],"additionalProperties":false,"title":"LocationsConnection.edges.[]","type":"object"},"title":"LocationsConnection.edges","type":"array"},"pageInfo":{"properties":{"endCursor":{"title":"LocationsConnection.pageInfo.endCursor","type":"string"},"hasNextPage":{"title":"LocationsConnection.pageInfo.hasNextPage","type":"boolean"},"hasPreviousPage":{"title":"LocationsConnection.pageInfo.hasPreviousPage","type":"boolean"},"startCursor":{"title":"LocationsConnection.pageInfo.startCursor","type":"string"}},"required":["hasNextPage","hasPreviousPage"],"additionalProperties":false,"title":"LocationsConnection.pageInfo","type":"object"},"totalCount":{"title":"LocationsConnection.totalCount","type":"number"}},"required":["edges","pageInfo","totalCount"],"additionalProperties":false,"title":"LocationsConnection","type":"object"},"ScanNoticeType":{"enum":["arrivedDamaged","damagedDuringHandling","lowQualityOriginal","cdOrDisc","flashDriveOrUsbDevice","exceedsPageLimit","emptyEnvelopeOrPackage","tooSmallOrFragilePaper","pagesTooLarge","bookletOrBoundItem","cantUseScannerOther","ballot","currency","creditCard","inappropriateContents","alcohol","perishables","multipleItems","returnedMail"],"title":"ScanNoticeType","type":"string"},"MailItem":{"properties":{"id":{"title":"MailItem.id","type":"string"},"from":{"title":"MailItem.from","type":"string"},"archivedAt":{"title":"MailItem.archivedAt","type":"string"},"readAt":{"title":"MailItem.readAt","type":"string"},"barcodeId":{"title":"MailItem.barcodeId","type":"string"},"businessRecipient":{"title":"MailItem.businessRecipient","description":"@deprecated Use the `recipients` field to get the recipient information","type":"string"},"individualRecipient":{"title":"MailItem.individualRecipient","description":"@deprecated Use the `recipients` field to get the recipient information","type":"string"},"recipients":{"properties":{"line1":{"properties":{"text":{"title":"MailItem.recipients.line1.text","type":"string"}},"required":["text"],"additionalProperties":false,"title":"MailItem.recipients.line1","type":"object"},"line2":{"properties":{"text":{"title":"MailItem.recipients.line2.text","type":"string"}},"required":["text"],"additionalProperties":false,"title":"MailItem.recipients.line2","type":"object"},"individual":{"properties":{"id":{"title":"MailItem.recipients.individual.id","type":"string"},"firstName":{"title":"MailItem.recipients.individual.firstName","type":"string"},"lastName":{"title":"MailItem.recipients.individual.lastName","type":"string"}},"required":["id","firstName","lastName"],"additionalProperties":false,"title":"MailItem.recipients.individual","type":"object"},"business":{"properties":{"id":{"title":"MailItem.recipients.business.id","type":"string"},"name":{"title":"MailItem.recipients.business.name","type":"string"}},"required":["id","name"],"additionalProperties":false,"title":"MailItem.recipients.business","type":"object"}},"required":["line1"],"additionalProperties":false,"title":"MailItem.recipients","type":"object"},"clearAt":{"title":"MailItem.clearAt","type":"string"},"imageUrl":{"title":"MailItem.imageUrl","type":"string"},"ocrResultUrls":{"items":{"type":"string"},"title":"MailItem.ocrResultUrls","type":"array"},"location":{"$ref":"#/components/schemas/Location"},"depositDetails":{"properties":{"trackingNumber":{"title":"MailItem.depositDetails.trackingNumber","description":"@deprecated Use the `trackingNumbers` field to get the tracking numbers","type":"string"},"trackingNumbers":{"items":{"type":"string"},"title":"MailItem.depositDetails.trackingNumbers","description":"The tracking numbers. May be empty when the selected service does not provide tracking.","type":"array"},"status":{"$ref":"#/components/schemas/Status"}},"required":["trackingNumbers","status"],"additionalProperties":false,"title":"MailItem.depositDetails","type":"object"},"forwardDetails":{"properties":{"id":{"title":"MailItem.forwardDetails.id","type":"string"},"trackingNumber":{"title":"MailItem.forwardDetails.trackingNumber","description":"@deprecated Use the `trackingNumbers` field to get the tracking numbers","type":"string"},"trackingNumbers":{"items":{"type":"string"},"title":"MailItem.forwardDetails.trackingNumbers","description":"The tracking numbers. May be empty when the selected service does not provide tracking.","type":"array"},"cost":{"title":"MailItem.forwardDetails.cost","description":"The shipping cost in cents, or null until the shipment ships.","type":"number"},"status":{"$ref":"#/components/schemas/Status"}},"required":["id","trackingNumbers","status"],"additionalProperties":false,"title":"MailItem.forwardDetails","type":"object"},"scanDetails":{"properties":{"imageUrl":{"title":"MailItem.scanDetails.imageUrl","type":"string"},"status":{"$ref":"#/components/schemas/Status"},"ocrResultUrls":{"items":{"type":"string"},"title":"MailItem.scanDetails.ocrResultUrls","type":"array"},"summary":{"title":"MailItem.scanDetails.summary","type":"string"},"scanNoticeType":{"title":"MailItem.scanDetails.scanNoticeType","description":"The category of the scan notice inserted into this scan (the page explaining why the\nmail could not be fully scanned in the usual way). Present only when a scan notice was\nissued for this mail item.\nSee: https://support.usestable.com/en/articles/14500610-what-is-a-scan-notice","allOf":[{"$ref":"#/components/schemas/ScanNoticeType"}]}},"required":["imageUrl","status"],"additionalProperties":false,"title":"MailItem.scanDetails","type":"object"},"shredDetails":{"properties":{"status":{"$ref":"#/components/schemas/Status"}},"required":["status"],"additionalProperties":false,"title":"MailItem.shredDetails","type":"object"},"checks":{"items":{"$ref":"#/components/schemas/Check"},"title":"MailItem.checks","type":"array"},"tags":{"items":{"$ref":"#/components/schemas/AssignedTag"},"title":"MailItem.tags","type":"array"},"teams":{"items":{"$ref":"#/components/schemas/Team"},"title":"MailItem.teams","type":"array"},"dataExtractionResults":{"items":{"$ref":"#/components/schemas/DataExtractionResult"},"title":"MailItem.dataExtractionResults","type":"array"},"isReturnedToSender":{"title":"MailItem.isReturnedToSender","description":"True if the mail item appears to be returned to sender.","type":"boolean"}},"required":["id","from","recipients","clearAt","imageUrl","location","depositDetails","forwardDetails","scanDetails","shredDetails","checks","tags","teams","dataExtractionResults"],"additionalProperties":false,"title":"MailItem","type":"object"},"Status":{"enum":["completed","processing"],"title":"Status","type":"string"},"MailItemsConnection":{"properties":{"edges":{"items":{"properties":{"cursor":{"title":"MailItemsConnection.edges.[].cursor","type":"string"},"node":{"$ref":"#/components/schemas/MailItem"}},"required":["cursor","node"],"additionalProperties":false,"title":"MailItemsConnection.edges.[]","type":"object"},"title":"MailItemsConnection.edges","type":"array"},"pageInfo":{"properties":{"endCursor":{"title":"MailItemsConnection.pageInfo.endCursor","type":"string"},"hasNextPage":{"title":"MailItemsConnection.pageInfo.hasNextPage","type":"boolean"},"hasPreviousPage":{"title":"MailItemsConnection.pageInfo.hasPreviousPage","type":"boolean"},"startCursor":{"title":"MailItemsConnection.pageInfo.startCursor","type":"string"}},"required":["hasNextPage","hasPreviousPage"],"additionalProperties":false,"title":"MailItemsConnection.pageInfo","type":"object"},"totalCount":{"title":"MailItemsConnection.totalCount","type":"number"}},"required":["edges","pageInfo","totalCount"],"additionalProperties":false,"title":"MailItemsConnection","type":"object"},"OnboardLocationPrefillBody":{"properties":{"isCompanyOfficerConfirmed":{"title":"OnboardLocationPrefillBody.isCompanyOfficerConfirmed","description":"Confirmation that the details provided are of a company officer (always set to true for now)","type":"boolean","example":"true"},"firstName":{"title":"OnboardLocationPrefillBody.firstName","description":"First name of the applicant","type":"string","example":"Ada"},"lastName":{"title":"OnboardLocationPrefillBody.lastName","description":"Last name of the applicant","type":"string","example":"Lovelace"},"phone":{"title":"OnboardLocationPrefillBody.phone","description":"Phone number of the applicant (company preferred, otherwise personal)","type":"string","example":"+19356836245"},"email":{"title":"OnboardLocationPrefillBody.email","description":"Email address of the applicant","type":"string","example":"ada@example.com"},"officerRole":{"title":"OnboardLocationPrefillBody.officerRole","description":"Role of the officer (if the `submissionType` is a business)","type":"string","example":"CEO"},"primaryIdType":{"title":"OnboardLocationPrefillBody.primaryIdType","description":"Primary ID must include a picture of the applicant and their name\nLearn more: https://support.usestable.com/en/articles/8236386-what-is-a-primary-id","example":"passport","allOf":[{"$ref":"#/components/schemas/PrimaryId"}]},"primaryIdNumber":{"title":"OnboardLocationPrefillBody.primaryIdNumber","description":"Document number on the applicant's primary ID","type":"string","example":"123456789"},"primaryIdIssuingEntity":{"title":"OnboardLocationPrefillBody.primaryIdIssuingEntity","description":"If the issuer is a state, provide state and country, otherwise provide country.","type":"string","example":"US"},"primaryIdExpirationDate":{"title":"OnboardLocationPrefillBody.primaryIdExpirationDate","description":"Date of expiration on the applicant's primary ID","type":"string","example":"2045-01-01"},"secondaryIdType":{"title":"OnboardLocationPrefillBody.secondaryIdType","description":"The Secondary ID must include the name and address of the applicant.\nLearn more: https://support.usestable.com/en/articles/8236383-what-is-a-secondary-id","example":"voter_card","allOf":[{"$ref":"#/components/schemas/SecondaryId"}]},"secondaryIdAddress":{"title":"OnboardLocationPrefillBody.secondaryIdAddress","description":"Address shown on the applicant's secondary ID","allOf":[{"$ref":"#/components/schemas/Address"}]},"submissionType":{"title":"OnboardLocationPrefillBody.submissionType","description":"If applicant is a business, then set `submissionType` to `business`, otherwise `individual`\n\nAdditional notes:\nIf `submissionType` is set to individual, then the following business related fields are cleared:\n- `businessType`\n- `legalBusinessName`\n- `officerRole`\n- `placeOfRegistration`","allOf":[{"$ref":"#/components/schemas/SubmissionType"}]},"legalBusinessName":{"title":"OnboardLocationPrefillBody.legalBusinessName","description":"Legal name of the business","type":"string","example":"Ada's Apples"},"placeOfRegistration":{"title":"OnboardLocationPrefillBody.placeOfRegistration","description":"If the business is in the United States, then \"county, state\" is required -- otherwise just \"country\".","type":"string","example":"Kent County, DE"},"businessType":{"title":"OnboardLocationPrefillBody.businessType","description":"The NAICS definition of the business.\nLearn more: https://www.census.gov/naics/?58967?yearbck=2022","type":"string","example":"Agriculture"},"redirectUrl":{"title":"OnboardLocationPrefillBody.redirectUrl","description":"Specify a URL to redirect the user to after the form is completed.\nIf provided, the confirmation page will display a button that redirects the user to your specified URL.\nIf not provided, the confirmation page will display a button that brings the user to the Stable login page.","type":"string","example":"https://usestable.com/after-onboarding-completed"}},"additionalProperties":false,"title":"OnboardLocationPrefillBody","description":"An object representing the body of the onboarding prefill request.","type":"object"},"PrimaryId":{"enum":["certificate_of_naturalization","matricula_consular","nexus","passport","uniformed_service","us_access_card","us_pr","us_state","us_university"],"title":"PrimaryId","type":"string"},"SecondaryId":{"enum":["current_lease","home_vehicle_insurance","mortgage_deed","us_state","vehicle_registration","voter_card"],"title":"SecondaryId","type":"string"},"Address":{"properties":{"line1":{"title":"Address.line1","description":"Required first line of the address","type":"string","example":"123 Main St"},"line2":{"title":"Address.line2","description":"Optional second line of the address","type":"string","example":"Apt 1"},"city":{"title":"Address.city","description":"Full name of the city","type":"string","example":"San Francisco"},"state":{"title":"Address.state","description":"Two character state code if in the United States, otherwise the full name of the state\nLearn more: https://en.wikipedia.org/wiki/ISO_3166-2:US","type":"string","example":"CA"},"postalCode":{"title":"Address.postalCode","description":"Five digit postal code of the address","type":"string","example":"94107"},"country":{"title":"Address.country","description":"ISO 3166-1 alpha-2 country code.\nLearn more: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2","type":"string","example":"US"}},"required":["line1","city","state","postalCode","country"],"additionalProperties":false,"title":"Address","type":"object"},"SubmissionType":{"enum":["individual","business"],"title":"SubmissionType","type":"string"},"SetMailItemsTagsRequestBody":{"properties":{"mailItemIds":{"items":{"title":"SetMailItemsTagsRequestBody.mailItemIds.[]","type":"string"},"title":"SetMailItemsTagsRequestBody.mailItemIds","type":"array"},"tags":{"items":{"properties":{"id":{"title":"SetMailItemsTagsRequestBody.tags.[].id","type":"string"},"isApplied":{"title":"SetMailItemsTagsRequestBody.tags.[].isApplied","type":"boolean"}},"required":["id","isApplied"],"additionalProperties":false,"title":"SetMailItemsTagsRequestBody.tags.[]","type":"object"},"title":"SetMailItemsTagsRequestBody.tags","type":"array"}},"required":["mailItemIds","tags"],"additionalProperties":false,"title":"SetMailItemsTagsRequestBody","type":"object"},"DocumentType":{"enum":["primary","secondary","selfie"],"title":"DocumentType","type":"string"},"FileType":{"enum":["jpg","jpeg","png","heic","pdf"],"title":"FileType","type":"string"},"OnboardLocationUploadUrlsRequestBody":{"properties":{"type":{"title":"OnboardLocationUploadUrlsRequestBody.type","description":"Specify which document you are uploading. You will have to upload all 3.","allOf":[{"$ref":"#/components/schemas/DocumentType"}]},"fileType":{"title":"OnboardLocationUploadUrlsRequestBody.fileType","description":"Specify the file type of the document you are uploading.","allOf":[{"$ref":"#/components/schemas/FileType"}]}},"required":["type","fileType"],"additionalProperties":false,"title":"OnboardLocationUploadUrlsRequestBody","type":"object"},"OnboardLocationUploadUrlsResponseBody":{"properties":{"uploadUrl":{"title":"OnboardLocationUploadUrlsResponseBody.uploadUrl","description":"A short-lived pre-signed s3 URL to upload your document.","type":"string"}},"required":["uploadUrl"],"additionalProperties":false,"title":"OnboardLocationUploadUrlsResponseBody","type":"object"},"SignaturePacket":{"properties":{"id":{"title":"SignaturePacket.id","description":"The ID of the signature packet.","type":"string"},"expiresAt":{"title":"SignaturePacket.expiresAt","description":"The expiration date of the signature packet URL.","type":"string"},"url":{"title":"SignaturePacket.url","description":"The URL to sign the signature packet.","type":"string"}},"required":["id","expiresAt","url"],"additionalProperties":false,"title":"SignaturePacket","type":"object"},"SuccessResponseBody":{"properties":{"success":{"title":"SuccessResponseBody.success","enum":[true],"type":"boolean"}},"required":["success"],"additionalProperties":false,"title":"SuccessResponseBody","type":"object"},"Tag":{"properties":{"id":{"title":"Tag.id","type":"string"},"name":{"title":"Tag.name","type":"string"},"createdAt":{"title":"Tag.createdAt","type":"string"},"updatedAt":{"title":"Tag.updatedAt","type":"string"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false,"title":"Tag","type":"object"},"AssignedTag":{"allOf":[{"$ref":"#/components/schemas/Tag"},{"properties":{"assignedAt":{"title":"assignedAt","type":"string"}},"required":["assignedAt"],"additionalProperties":false,"type":"object"}],"title":"AssignedTag"},"UpdateCompanyRequestBody":{"properties":{"legalName":{"title":"UpdateCompanyRequestBody.legalName","description":"Legal name of the company.","type":"string"},"entityType":{"title":"UpdateCompanyRequestBody.entityType","description":"Entity type of the company.","allOf":[{"$ref":"#/components/schemas/CompanyEntityType"}]},"jurisdictions":{"items":{"$ref":"#/components/schemas/State"},"title":"UpdateCompanyRequestBody.jurisdictions","description":"The complete list of states in which the company operates. The list you provide replaces the\ncurrent list. It must include the company's formation jurisdiction, or the new one if you also\npass `formationJurisdiction`. States with an active registered agent or active monitoring\nservice cannot be removed.","type":"array"},"formationJurisdiction":{"title":"UpdateCompanyRequestBody.formationJurisdiction","description":"State in which the company was formed. If you do not pass `jurisdictions`, the current list is\nautomatically updated to include the new formation jurisdiction.","allOf":[{"$ref":"#/components/schemas/State"}]},"formationDate":{"title":"UpdateCompanyRequestBody.formationDate","description":"Date the company was formed, in YYYY-MM-DD format.","type":"string","example":"2024-01-15"},"ein":{"title":"UpdateCompanyRequestBody.ein","description":"Employer Identification Number in the format xx-xxxxxxx.","type":"string","example":"12-3456789"}},"additionalProperties":false,"title":"UpdateCompanyRequestBody","type":"object"},"UpdateTagRequestBody":{"properties":{"name":{"title":"UpdateTagRequestBody.name","type":"string"}},"required":["name"],"additionalProperties":false,"title":"UpdateTagRequestBody","type":"object"},"UpdateTagResponseBody":{"properties":{"tag":{"$ref":"#/components/schemas/Tag"}},"required":["tag"],"additionalProperties":false,"title":"UpdateTagResponseBody","type":"object"},"USPS1583SharedSession":{"properties":{"id":{"title":"USPS1583SharedSession.id","type":"string"},"expiresAt":{"title":"USPS1583SharedSession.expiresAt","type":"string"},"url":{"title":"USPS1583SharedSession.url","type":"string"}},"required":["id","expiresAt","url"],"additionalProperties":false,"title":"USPS1583SharedSession","type":"object"},"Team":{"properties":{"id":{"title":"Team.id","type":"string"},"name":{"title":"Team.name","type":"string"},"createdAt":{"title":"Team.createdAt","type":"string"},"updatedAt":{"title":"Team.updatedAt","type":"string"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false,"title":"Team","type":"object"},"CreateTeamsRequestBody":{"properties":{"teams":{"items":{"properties":{"name":{"title":"CreateTeamsRequestBody.teams.[].name","type":"string"}},"required":["name"],"additionalProperties":false,"title":"CreateTeamsRequestBody.teams.[]","type":"object"},"title":"CreateTeamsRequestBody.teams","type":"array"}},"required":["teams"],"additionalProperties":false,"title":"CreateTeamsRequestBody","type":"object"},"CreateTeamsResponseBody":{"properties":{"teams":{"items":{"$ref":"#/components/schemas/Team"},"title":"CreateTeamsResponseBody.teams","type":"array"}},"required":["teams"],"additionalProperties":false,"title":"CreateTeamsResponseBody","type":"object"},"DeleteTeamsRequestBody":{"properties":{"teams":{"items":{"properties":{"id":{"title":"DeleteTeamsRequestBody.teams.[].id","type":"string"}},"required":["id"],"additionalProperties":false,"title":"DeleteTeamsRequestBody.teams.[]","type":"object"},"title":"DeleteTeamsRequestBody.teams","type":"array"}},"required":["teams"],"additionalProperties":false,"title":"DeleteTeamsRequestBody","type":"object"},"GetTeamsResponseBody":{"properties":{"teams":{"items":{"$ref":"#/components/schemas/Team"},"title":"GetTeamsResponseBody.teams","type":"array"}},"required":["teams"],"additionalProperties":false,"title":"GetTeamsResponseBody","type":"object"},"RenameTeamRequestBody":{"properties":{"name":{"title":"RenameTeamRequestBody.name","type":"string"}},"required":["name"],"additionalProperties":false,"title":"RenameTeamRequestBody","type":"object"},"RenameTeamResponseBody":{"properties":{"team":{"$ref":"#/components/schemas/Team"}},"required":["team"],"additionalProperties":false,"title":"RenameTeamResponseBody","type":"object"},"SetMailItemsTeamsRequestBody":{"properties":{"mailItemIds":{"items":{"title":"SetMailItemsTeamsRequestBody.mailItemIds.[]","type":"string"},"title":"SetMailItemsTeamsRequestBody.mailItemIds","type":"array"},"teams":{"items":{"properties":{"id":{"title":"SetMailItemsTeamsRequestBody.teams.[].id","type":"string"},"isApplied":{"title":"SetMailItemsTeamsRequestBody.teams.[].isApplied","type":"boolean"}},"required":["id","isApplied"],"additionalProperties":false,"title":"SetMailItemsTeamsRequestBody.teams.[]","type":"object"},"title":"SetMailItemsTeamsRequestBody.teams","type":"array"}},"required":["mailItemIds","teams"],"additionalProperties":false,"title":"SetMailItemsTeamsRequestBody","type":"object"},"CreateShipmentsRequestBody":{"properties":{"mailItemIds":{"items":{"title":"CreateShipmentsRequestBody.mailItemIds.[]","type":"string"},"title":"CreateShipmentsRequestBody.mailItemIds","description":"IDs of the mail items to ship. Repeated IDs are treated as a single item.","type":"array"},"recipient":{"title":"CreateShipmentsRequestBody.recipient","description":"Name on the shipping label. Person or company name.","type":"string","example":"Jane Doe"},"phone":{"title":"CreateShipmentsRequestBody.phone","description":"Phone number the carrier can contact about the delivery. Include the\ncountry code for numbers outside the US, such as +44 20 7946 0958; a\nnumber without one is read as a US number.","type":"string","example":"+1 212 555 1234"},"address":{"title":"CreateShipmentsRequestBody.address","description":"Destination address for the supplied mail item IDs.","allOf":[{"$ref":"#/components/schemas/ShipmentAddress"}]},"serviceCode":{"title":"CreateShipmentsRequestBody.serviceCode","description":"The shipping method for every shipment this call creates. It must appear\non each shipment's menu in the `POST /v1/shipping-methods` response for\nthe same mail items and destination. To use a different method for a\nsubset of the items, ship that subset in its own call.","type":"string","example":"usps_first_class_mail"}},"required":["mailItemIds","recipient","phone","address","serviceCode"],"additionalProperties":false,"title":"CreateShipmentsRequestBody","type":"object"},"ShipmentStatus":{"enum":["processing","completed"],"title":"ShipmentStatus","type":"string"},"Shipment":{"properties":{"id":{"title":"Shipment.id","description":"Shipment ID. Mail items shipped together share it, so a cost that arrives\nlater belongs to the shipment rather than to each item. The same ID\nappears as `forwardDetails.id` on the mail item and on the\n`mailItem.forward.*` webhook payloads.","type":"string","example":"9b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e"},"mailItemIds":{"items":{"title":"Shipment.mailItemIds.[]","type":"string"},"title":"Shipment.mailItemIds","description":"IDs of the mail items in this shipment.","type":"array"},"serviceCode":{"title":"Shipment.serviceCode","description":"Shipping service used for this shipment. Echoes the `serviceCode` from the request.","type":"string","example":"usps_first_class_mail"},"status":{"title":"Shipment.status","description":"The status of the shipment. `processing` means the request was accepted;\n`completed` means it shipped, and the tracking number and cost on the\nmail item are final.","example":"processing","allOf":[{"$ref":"#/components/schemas/ShipmentStatus"}]},"createdAt":{"title":"Shipment.createdAt","description":"ISO 8601 timestamp when the shipment was requested.","type":"string","example":"2026-07-23T14:22:00.000Z"}},"required":["id","mailItemIds","serviceCode","status","createdAt"],"additionalProperties":false,"title":"Shipment","type":"object"},"CreateShipmentsResponseBody":{"properties":{"shipments":{"items":{"$ref":"#/components/schemas/Shipment"},"title":"CreateShipmentsResponseBody.shipments","description":"One entry per shipment. Mail items in one call are split into multiple\nshipments when they live in different mailboxes.","type":"array"}},"required":["shipments"],"additionalProperties":false,"title":"CreateShipmentsResponseBody","type":"object"},"ShipmentAddress":{"properties":{"line1":{"title":"ShipmentAddress.line1","description":"Street address.","type":"string","example":"123 Main St"},"line2":{"title":"ShipmentAddress.line2","description":"Apartment, suite, etc.","type":"string","example":"Apt 4B"},"city":{"title":"ShipmentAddress.city","type":"string","example":"Brooklyn"},"state":{"title":"ShipmentAddress.state","description":"For destinations in the United States, the two-letter state code (e.g. `NY`).\n\nFor other destinations, the free-form state, province, or region (e.g. `Greater London`).","type":"string","example":"NY"},"postalCode":{"title":"ShipmentAddress.postalCode","type":"string","example":"11201"},"country":{"title":"ShipmentAddress.country","description":"ISO 3166-1 alpha-2 country code.\n\nLearn more: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2","type":"string","example":"US"}},"required":["line1","city","state","postalCode","country"],"additionalProperties":false,"title":"ShipmentAddress","type":"object"},"ShippingMethodsRequestBody":{"properties":{"mailItemIds":{"items":{"title":"ShippingMethodsRequestBody.mailItemIds.[]","type":"string"},"title":"ShippingMethodsRequestBody.mailItemIds","description":"IDs of the mail items the shipping methods are intended for. The available methods\ndepend on the specific mail items and the destination address.","type":"array"},"address":{"title":"ShippingMethodsRequestBody.address","description":"Destination address for the supplied mail items.","allOf":[{"$ref":"#/components/schemas/ShipmentAddress"}]}},"required":["mailItemIds","address"],"additionalProperties":false,"title":"ShippingMethodsRequestBody","type":"object"},"EstimatedCost":{"properties":{"label":{"title":"EstimatedCost.label","description":"The estimated cost to display alongside the method's `label`, or null. Actual shipping costs\nvary based on the size, distance, and type of shipping.","nullable":true,"type":"string","example":"$1.00+ for letters, $6.48+ for packages"}},"required":["label"],"additionalProperties":false,"title":"EstimatedCost","type":"object"},"ShippingMethod":{"properties":{"serviceCode":{"title":"ShippingMethod.serviceCode","description":"Machine-readable identifier to pass back as `serviceCode` on `POST /v1/shipments`.","type":"string","example":"usps_first_class_mail"},"label":{"title":"ShippingMethod.label","type":"string","example":"USPS First Class Mail"},"carrierCode":{"title":"ShippingMethod.carrierCode","description":"Carrier identifier, useful for grouping or rendering carrier-specific UI.\nNot an input on `POST /v1/shipments`; use `serviceCode`.","type":"string","example":"usps"},"estimatedCost":{"title":"ShippingMethod.estimatedCost","description":"The estimated cost of shipping with this method, or null when we can't estimate it. Only\navailable to some accounts.","type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/EstimatedCost"}]}},"required":["serviceCode","label","carrierCode","estimatedCost"],"additionalProperties":false,"title":"ShippingMethod","type":"object"},"ShipmentPreview":{"properties":{"mailItemIds":{"items":{"title":"ShipmentPreview.mailItemIds.[]","type":"string"},"title":"ShipmentPreview.mailItemIds","description":"Mail items that would ship together as one shipment.","type":"array"},"shippingMethods":{"items":{"$ref":"#/components/schemas/ShippingMethod"},"title":"ShipmentPreview.shippingMethods","description":"The shipping methods valid for this shipment and destination. An empty\nlist means that no shipping methods are available to ship to the destination address.","type":"array"}},"required":["mailItemIds","shippingMethods"],"additionalProperties":false,"title":"ShipmentPreview","type":"object"},"ShippingMethodsResponseBody":{"properties":{"shipments":{"items":{"$ref":"#/components/schemas/ShipmentPreview"},"title":"ShippingMethodsResponseBody.shipments","description":"One entry per shipment. Mail items from the same mailbox ship together as\none shipment. To use a different service for each shipment, send one\n`POST /v1/shipments` request per group.","type":"array"}},"required":["shipments"],"additionalProperties":false,"title":"ShippingMethodsResponseBody","type":"object"}}}}