{"openapi":"3.0.0","info":{"contact":{"email":"contact@youtrust.com","name":"Support","url":"https://youtrust.com/contact"},"description":"Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Youtrust API.","license":{"name":"proprietary","url":"https://youtrust.com/terms"},"title":"Public Api v3","version":"3.0"},"servers":[{"description":"Sandbox URL","url":"https://api-sandbox.yousign.app/v3"},{"description":"Production URL","url":"https://api.yousign.app/v3"}],"security":[{"bearerAuth":[]}],"tags":[{"description":"Person responsible for validating a Signature Request.","name":"Approver"},{"description":"Set of documents generated once a Signature Request is completed.","name":"Audit Trail"},{"description":"This resource provides tracking of the API usage.","name":"Consumption"},{"description":"A saved profile containing some information (name, language, email address, etc.) that can be re-used to create a Signer, Approver, or Follower.","name":"Contact"},{"description":"Allows to customize the look and feel of the signature experience.","name":"Custom Experience"},{"description":"A configurable field (list or text) allowing to tag Signature Requests with structured values.","name":"Custom Property"},{"description":"Document that is attached to the Signature Request.","name":"Document"},{"description":"This resource is the digital version of the company stamp.","name":"Electronic Seal"},{"description":"Set of documents generated once a Electronic Seal is completed.","name":"Electronic Seal Audit Trail"},{"description":"Document that is attached to the Electronic Seal.","name":"Electronic Seal Document"},{"description":"Set of Image which can be used in Electronic Seal.","name":"Electronic Seal Image"},{"description":"Dynamic content that will appear on a Document.","name":"Field"},{"description":"Person who is kept informed about the progress of the signing process without being an Approver or a Signer.","name":"Follower"},{"description":"Categorization tag that can be added to a Signature Request.","name":"Label"},{"description":"Extra information attached to a Signature Request.","name":"Metadata"},{"description":"Process of inviting Signers to sign a Document.","name":"Signature Request"},{"description":"Person who will sign a Signature Request.","name":"Signer"},{"description":"Process of asking signers to upload specific documents during the signature process.","name":"Signer Document Request"},{"description":"Process of asking signers to consent to specific needs during the signature process.","name":"Signer Consent Request"},{"description":"A person who can access the Youtrust web app of your organization.","name":"User"},{"description":"The Invitation of a new User to join the Youtrust organization.","name":"User Invitation"},{"description":"Webhook subscription; enables real-time notifications about events that happen in your Youtrust organization.","name":"Webhook"},{"description":"A way to partition your Youtrust organization into separate entities.","name":"Workspace"},{"description":"Pre-configuration of all elements of a Signature Request, such as Documents, Signers, Approvers, Fields, and settings.","name":"Template"},{"description":"A feature allowing to store and retrieve documents on Arkhineo for some customers migrated from v2","name":"Archive"},{"description":"Operations that are in beta version, and may be changed or removed in the future.","name":"Beta"},{"description":"Operations that are no longer recommended for use.","name":"Deprecated"},{"description":"KYC Process of verifying the identity associated with a bank account document.","name":"Bank Account Verification"},{"description":"KYC Process of verifying the identity associated with an identity document.","name":"Identity Document Verification"},{"description":"KYC Process of verifying the identity associated with a document.","name":"Identity Video Verification"},{"description":"Retrieve structured and official data about a company.","name":"Company Verification"},{"description":"Check if individuals appear on international sanctions lists or as politically exposed persons (PEPs).","name":"Watchlist Verification"},{"description":"KYC Process of verifying a proof of address document.","name":"Proof of Address Verification"},{"description":"KYC Process of verifying a person’s or company’s banking information via the Sepamail DIAMOND network.","name":"Bank Account Lookup Verification"},{"description":"Instance of a workflow created each time a customer goes through it.","name":"Workflow Session"},{"description":"An applicant associated with a Workflow Session.","name":"Applicant"},{"description":"Structure of a workflow defined by the type of Actions a customer must complete.","name":"Workflow Template"},{"description":"Analyze a document and extract structured data.","name":"Document Trust Analysis"},{"description":"Set of documents generated once a Verification is completed.","name":"Verification Audit Trail"}],"paths":{"/archives":{"post":{"description":"Archive a file in a secure digital safe for 10 years","operationId":"post-archives","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadArchivedFile"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchivedFile"}}},"description":"The upload of the archived file is successful.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Direct upload an archived file","tags":["Archive"]}},"/archives/{archivedFileId}/download":{"get":{"description":"Download the archived file using the ArchivedFileId.","operationId":"get-archives-archivedFileId-download","parameters":[{"description":"ArchivedFileId","in":"path","name":"archivedFileId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"format":"binary","type":"string"}}},"description":"Download of archived file is successful","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download archived file","tags":["Archive"]}},"/consumptions":{"get":{"deprecated":true,"description":"Get signatures Consumption by source","operationId":"get-consumptions","parameters":[{"description":"The \"from\" date must not be more than 1 year in the past","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"The \"to\" date must be more recent than the \"from\" date","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"The API authentication key to use to retrieve the data","in":"query","name":"authentication_key","schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consumption"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get Consumptions","tags":["Consumption"]}},"/consumptions/addons":{"get":{"description":"Retrieves detailed addon consumption for the current subscription period.","operationId":"get-consumption-addon","parameters":[{"description":"A list of add-ons to filter the results on.","in":"query","name":"addons","required":false,"schema":{"items":{"$ref":"#/components/schemas/AddonConsumptionsName"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_consumption_addon_200_response"}}},"description":"Return the addons consumption per addon.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get detailed addon consumption.","tags":["Consumption"]}},"/consumptions/detail":{"get":{"description":"Returns the consumption of your organization over a specified period.","operationId":"get-consumption-detail","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"The starting date for data retrieval.","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"The end date for data retrieval. The `to` date must be later than the `from` date and within one year of the `from` date.","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"Specifies how data is grouped. By default, it returns the total consumption for the entire organization. If set to `workspace`, the data will be grouped by Workspace.","in":"query","name":"breakdown_type","required":false,"schema":{"default":"organization","enum":["organization","workspace"],"type":"string"}},{"description":"A list of Workspace IDs to filter the results.","in":"query","name":"workspace_ids","required":false,"schema":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_consumption_detail_200_response"}}},"description":"Return the detailed consumption.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get detailed Consumption data","tags":["Consumption"]}},"/consumptions/export":{"get":{"description":"Get a binary .csv file containing all the Consumption data of the underlying signatures","operationId":"get-consumptions-export","parameters":[{"description":"The \"from\" date must not be more than 1 year in the past","in":"query","name":"from","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"The \"to\" date must be more recent than the \"from\" date","in":"query","name":"to","required":true,"schema":{"$ref":"#/components/schemas/DateYMD"}},{"description":"The API authentication key to use to retrieve the data","in":"query","name":"authentication_key","schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Returns a .csv file containing the raw Consumption data.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Export Consumption data","tags":["Consumption"]}},"/consumptions/records/electronic_seals":{"get":{"description":"Returns the list of Electronic Seal consumption records.","operationId":"get-consumptions-records-electronic_seals","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `created_at`. Allowed operators: `between`, `before`, `after`.\nFormat: `yyyy-mm-dd`\nExamples:\n  - `created_at[between]=2025-03-02,2025-03-04`\n  - `created_at[after]=2025-03-02`\n","example":{"between":["2025-03-02","2025-03-04"],"before":["2025-03-02"]},"explode":true,"in":"query","name":"created_at","required":false,"schema":{"description":"Filter by date of creation.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_consumptions_records_electronic_seals_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get Electronic Seals consumption records","tags":["Consumption"]}},"/consumptions/records/identifications":{"get":{"description":"Returns the list of Identifications consumption records.","operationId":"get-consumptions-records-identifications","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `created_at`. Allowed operators: `between`, `before`, `after`.\nFormat: `yyyy-mm-dd`\nExamples:\n  - `created_at[between]=2025-03-02,2025-03-04`\n  - `created_at[after]=2025-03-02`\n","example":{"between":["2025-03-02","2025-03-04"],"before":["2025-03-02"]},"explode":true,"in":"query","name":"created_at","required":false,"schema":{"description":"Filter by date of creation.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_consumptions_records_identifications_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get Identifications consumption records","tags":["Consumption"]}},"/consumptions/records/invited_signers":{"get":{"description":"Returns the list of Invited signers consumption records.","operationId":"get-consumptions-records-invited_signers","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `created_at`. Allowed operators: `between`, `before`, `after`.\nFormat: `yyyy-mm-dd`\nExamples:\n  - `created_at[between]=2025-03-02,2025-03-04`\n  - `created_at[after]=2025-03-02`\n","example":{"between":["2025-03-02","2025-03-04"],"before":["2025-03-02"]},"explode":true,"in":"query","name":"created_at","required":false,"schema":{"description":"Filter by date of creation.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_consumptions_records_invited_signers_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get Invited signers consumption records","tags":["Consumption"]}},"/contacts":{"get":{"description":"Returns the list of all the Contacts within your organization.","operationId":"get-contacts","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_contacts_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Contacts","tags":["Contact"]},"post":{"description":"Creates a new Contact.","operationId":"post-contact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContact"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a Contact","tags":["Contact"]}},"/contacts/{contactId}":{"delete":{"description":"Deletes a given Contact.","operationId":"delete-contacts-contactId","parameters":[{"description":"Contact Id","in":"path","name":"contactId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Contact","tags":["Contact"]},"get":{"description":"Retrieves a given Contact.","operationId":"get-contacts-contactId","parameters":[{"description":"Contact Id","in":"path","name":"contactId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Contact","tags":["Contact"]},"patch":{"description":"Updates a given Contact.\nAny parameters not provided are left unchanged.\n","operationId":"patch-contacts-contactId","parameters":[{"description":"Contact Id","in":"path","name":"contactId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContact"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Contact","tags":["Contact"]}},"/custom_experiences":{"get":{"description":"Returns the list of all Custom Experiences in your Organization.\nYou can limit the number of items returned by using pagination.\n","operationId":"get-custom_experiences","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_custom_experiences_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Custom Experiences","tags":["Custom Experience"]},"post":{"description":"Creates a new Custom Experience.","operationId":"post-custom-experience","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomExperience"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomExperience"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a Custom Experience","tags":["Custom Experience"]}},"/custom_experiences/{customExperienceId}":{"delete":{"description":"Deletes a given Custom Experience.","operationId":"delete-custom_experience","parameters":[{"description":"Custom Experience Id","in":"path","name":"customExperienceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Custom Experience","tags":["Custom Experience"]},"get":{"description":"Retrieves a given Custom Experience.","operationId":"get-custom_experiences-customExperienceId","parameters":[{"description":"Custom Experience Id","in":"path","name":"customExperienceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomExperience"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Custom Experience","tags":["Custom Experience"]},"patch":{"description":"Updates a given Custom Experience.\nAny parameters not provided are left unchanged.\n","operationId":"patch-custom_experiences-customExperienceId","parameters":[{"description":"Custom Experience Id","in":"path","name":"customExperienceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomExperience"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomExperience"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Custom Experience","tags":["Custom Experience"]}},"/custom_experiences/{customExperienceId}/logo":{"delete":{"description":"Deletes the logo of a Custom Experience.","operationId":"delete-custom_experience-logo","parameters":[{"description":"Custom Experience Id","in":"path","name":"customExperienceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Custom Experience logo","tags":["Custom Experience"]},"post":{"description":"Updates the logo of a given Custom Experience by uploading the image of your choice.","operationId":"patch-custom-experience-logo","parameters":[{"description":"Custom Experience Id","in":"path","name":"customExperienceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/patch_custom_experience_logo_request"}}},"description":"Update a Custom Experience logo"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomExperience"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Custom Experience logo","tags":["Custom Experience"]}},"/custom_properties":{"get":{"description":"Returns all custom properties for the organization.\nResults are paginated using cursor-based pagination.\nSupports filtering by workspace and type.\n","operationId":"get-custom_properties","parameters":[{"description":"Filter properties applicable to a specific workspace.\nReturns org-wide properties plus properties scoped to the specified workspace.\n","in":"query","name":"workspace_id","required":false,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Filter by field type.","in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/CustomPropertyType"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomPropertyList"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Custom Properties","tags":["Custom Property"]},"post":{"description":"Creates a new custom property for the organization.\nThe property type (text or list) cannot be changed after creation.\n","operationId":"post-custom_properties","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomProperty"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomProperty"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a Custom Property","tags":["Custom Property"]}},"/custom_properties/{customPropertyId}":{"delete":{"description":"Deletes a given Custom Property.","operationId":"delete-custom_properties-id","parameters":[{"description":"Custom Property Id","in":"path","name":"customPropertyId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Custom Property","tags":["Custom Property"]},"get":{"description":"Retrieves a specific custom property by its ID.\nReturns the complete property definition including all options for list types.\n","operationId":"get-custom_properties-id","parameters":[{"description":"Custom Property Id","in":"path","name":"customPropertyId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomProperty"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Custom Property","tags":["Custom Property"]},"patch":{"description":"Updates a given custom property. Any parameters not provided are left unchanged.\nThe property type cannot be changed after creation.\nFor list properties, the options array must be sent in full to replace all options.\n","operationId":"patch-custom_properties-id","parameters":[{"description":"Custom Property Id","in":"path","name":"customPropertyId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomProperty"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomProperty"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Custom Property","tags":["Custom Property"]}},"/document_analyses":{"get":{"description":"Returns the list of all Document Trust Analyses within your organization.\nYou can limit the number of items returned by using filters and pagination.\nConsult our [guide](https://developers.youtrust.com/docs/document-analysis) for more details and examples.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Document Analysis or Document Trust Advanced`\n","operationId":"get-document_analyses","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=done`\n","example":{"eq":["done"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `type`. Allowed operators: `eq`.\nExample: `type[eq]=social_security`\n","example":{"eq":["social_security"]},"explode":true,"in":"query","name":"type","required":false,"schema":{"description":"Filter by type.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workflow_session_id`. Allowed operators: `eq`.\nExample: `workflow_session_id[eq]=18a5e211-ff33-48e2-810c-a0397b558611`\n","example":{"eq":["18a5e211-ff33-48e2-810c-a0397b558611"]},"explode":true,"in":"query","name":"workflow_session_id","required":false,"schema":{"description":"Filter by workflow_session_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_document_analyses_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Document Trust Analyses","tags":["Document Trust Analysis"]},"post":{"description":"Initiate a new Document Trust Analysis to extract data from a given document type.\n\nRelated guide: [Document Trust Analysis](https://developers.youtrust.com/docs/document-analysis)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file containing the document to analyse.\n- 📝 `application/json` — reference an existing Workflow Session Applicant by ID.\n\n**🔎 Analysis type (`analysis_type`)**\n- `extraction: true` (default): data is extracted from the document. A document `type` is **required**. Optionally set `fraud_level` (`standard` or `advanced`) to also run fraud detection (not supported for `tax_notice`).\n- `extraction: false` (fraud-only): no data extraction. `type` must be omitted and `fraud_level` must be `advanced`.\n\nOn `multipart/form-data`, `analysis_type` is sent as form fields (`analysis_type[extraction]`, `analysis_type[fraud_level]`) and `extraction` is a string (`\"true\"`/`\"false\"`).\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access):\n  - For extraction only `Document Analysis`\n  - For Fraud Detection with `fraud_level` set to `standard` and Extraction `Document Trust Standard`\n  - For Fraud Detection with `fraud_level` set to `advanced` and Extraction `Document Trust Advanced`\n","operationId":"post-document_analyses","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateDocumentAnalysisFromApplicant"}},"multipart/form-data":{"encoding":{"checks":{"explode":true,"style":"deepObject"},"analysis_type":{"explode":true,"style":"deepObject"}},"schema":{"$ref":"#/components/schemas/InitiateDocumentAnalysisFromMultipart"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_document_analyses_201_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Document Trust Analysis","tags":["Document Trust Analysis"],"x-readme":{"explorer-enabled":false}}},"/document_analyses/{documentAnalysisId}":{"get":{"description":"Get the detailed results of a Document Trust Analysis.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Document Analysis or Document Trust Advanced`\n","operationId":"get-document_analyses-id","parameters":[{"description":"Document Trust Analysis Id","in":"path","name":"documentAnalysisId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"social_security":{"summary":"Social Security","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"social_security","extracted_from_document":{"social_security_number":"1234567890123","first_name":"John","last_name":"Doe","full_name":"John Doe","document_type":"Carte vitale"},"checks":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}}},"company_certificate":{"summary":"Company Certificate","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"company_certificate","extracted_from_document":{"verification_number":"1234567890123","company_name":"Acme","company_number":"1234567890","registered_address":"1 rue de la paix, 75000 Paris","issuance_date":"2025-01-01","legal_representatives":[{"type":"natural_person","first_name":"John","last_name":"Doe","full_name":"John Doe","function":"Président","company_name":null,"company_number":null},{"type":"legal_person","first_name":null,"last_name":null,"full_name":null,"company_name":"Acme Studio","company_number":"0987654321","function":"Dirigeant"}],"document_type":"KBIS"},"checks":{"legal_representatives":[{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}]}}},"business_registration_certificate":{"summary":"Business Registration Certificate","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"business_registration_certificate","extracted_from_document":{"issuance_date":"2025-01-01","company_description":{"active":true,"legal_form":"Entreprise individuelle","company_name":null,"company_number":"123 4567 890","headquarter_company_number":"123 4567 890 12345","first_name":"John","last_name":"Doe","full_name":"John Doe"},"branch_description":{"active":true,"branch_company_number":"123 4567 890 12345","address":"1 rue de la paix, 75000 Paris","city":"Paris","postal_code":"75000"},"document_type":"Avis de situation"},"checks":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}}},"driver_licence":{"summary":"Driver Licence","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"driver_licence","extracted_from_document":{"first_name":"John","last_name":"Doe","full_name":"John Doe","born_on":"1990-01-15","expired_on":"2030-12-31","license_type":["B","A1"],"document_type":"Permis de conduire français (nouveau format)"},"checks":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}}},"rne_certificate":{"summary":"RNE Certificate","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"rne_certificate","extracted_from_document":{"company_name":"ACME Corp","company_number":"123456789","registered_address":"1 rue de la paix, 75000 Paris","issuance_date":"2024-01-15","legal_representatives":[{"type":"natural_person","first_name":"John","last_name":"Doe","full_name":"John Doe","function":"President","company_name":null,"company_number":null},{"type":"legal_person","first_name":null,"last_name":null,"full_name":null,"company_name":"ACME Studio","company_number":"0987654321","function":"Statutory Auditor"}],"document_type":"Attestation RNE"},"checks":{"legal_representatives":[{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}]}}},"temporary_vehicle_registration_document":{"summary":"Temporary Vehicle Registration Document (IT)","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":"IT","data_anonymized":false,"applicant_id":null,"type":"temporary_vehicle_registration_document","extracted_from_document":{"vehicle_category":"M1","vehicle_license_number":"DH000SJ","vehicle_identification_number":"ZFA19900001244827","vehicle_purpose":"PROPRIO","vehicle_first_registration_year":"2018","vehicle_owner_information":{"vehicle_owner_full_name":"DOE JOHN","vehicle_owner_birth_date":"1985-06-15","vehicle_owner_address":"VIA ROMA 10, 00100 ROMA RM"},"other_details":"Veicolo ad uso privato","issuance_date":"2024-03-15","document_reason":"PASSAGGIO DI PROPRIETA","document_recipient_information":{"document_recipient_full_name":"DOE JOHN","document_recipient_address":"VIA ROMA 10, 00100 ROMA RM","document_recipient_birth_date":"1985-06-15","document_recipient_birth_city":"ROMA"}},"checks":{"vehicle_owner":{"owner_name":{"extracted":"DOE JOHN","expected":"Doe John","match_level":"exact"}}}}},"vehicle_registration_document_fr":{"summary":"French Vehicle Registration Document","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":"FR","data_anonymized":false,"applicant_id":null,"type":"vehicle_registration_document","extracted_from_document":{"licence_plate_number":"AB-123-CD","first_registration_date":"2020-01-15","owner_information":{"owner_full_name":"John Doe","owner_address":"1 rue de la Paix, 75001 Paris","owner_type":"natural_person"},"co_owner_information":[],"vehicle_information":{"vehicle_brand":"Renault","vehicle_version":null,"vehicle_model":"Clio"},"vehicle_identification_number":"VF1AB000012345678","vehicle_max_weight":1800,"vehicle_motor_information":{"vehicle_fuel_type":"Essence","vehicle_fiscal_power":6,"vehicle_max_power":96,"vehicle_power":74},"document_number":"2020AB12345","issuance_date":"2020-01-20","vehicle_next_inspection_date":"2024-01-20","mrz_line_1":null,"mrz_line_2":null,"document_type":null},"checks":{"vehicle_owner":{"owner_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}}}},"vehicle_registration_document_it":{"summary":"Italian Vehicle Registration Document","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":"IT","data_anonymized":false,"applicant_id":null,"type":"vehicle_registration_document","extracted_from_document":{"licence_plate_number":"DH000SJ","first_registration_date":"2018-06-15","owner_information":{"owner_full_name":"DOE JOHN","owner_address":"VIA ROMA 10, 00100 ROMA RM","owner_type":"natural_person","owner_birth_date":"1985-06-15"},"co_owner_information":[],"deed_informations":[],"vehicle_information":{"vehicle_brand":"FIAT","vehicle_version":null,"vehicle_model":"500"},"vehicle_body":"Berlina","vehicle_identification_number":"ZFA19900001244827","vehicle_total_mass":1500,"vehicle_motor_information":{"vehicle_fuel_type":"Benzina","vehicle_max_power":51,"vehicle_displacement_type":1242},"document_type":null,"issuance_date":"2018-07-01","vehicle_approval_number":null,"vehicle_destination_and_use":null,"international_vehicle_category":"M1","mass_of_the_vehicle_in_service":1050,"vehicle_maximum_technical_mass":1500,"vehicle_maximum_permissible_mass":1500},"checks":{"vehicle_owner":{"owner_name":{"extracted":"DOE JOHN","expected":"Doe John","match_level":"exact"}}}}},"auto_insurance_claims_history":{"summary":"Auto Insurance Claims History","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"auto_insurance_claims_history","extracted_from_document":{"policy_holder_full_name":"John Doe","policy_holder_address":"1 rue de la Paix, 75001 Paris","policy_holder_birth_date":"1990-01-01","insurance_score":"0.50","issuance_date":"2024-01-15","effective_start_date":"2023-01-01","active_contract":true,"contract_cancellation_date":null,"vehicle_model":"Renault Clio","vehicle_license_plate":"AB-123-CD","drivers_information":[{"driver_full_name":"John Doe","driver_birth_date":"1990-01-01","coverage_start_date":"2023-01-01","coverage_end_date":null,"driver_license_number":"12345678","driver_license_category":"B","driver_license_issuance_date":"2010-06-15"}],"incidents_information":[]},"checks":{"policy_holder":{"owner_name":{"extracted":"Doe John","expected":"Doe John","match_level":"exact"}}}}},"tax_notice":{"summary":"Tax Notice","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":null,"previous_attempt_id":null,"created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"done","status_codes":[],"country_code":null,"data_anonymized":false,"applicant_id":null,"type":"tax_notice","extracted_from_document":{"full_name":"Doe John","fiscal_number_1":"0312345678901","fiscal_number_2":"0398765432109","tax_notice_reference":"2412B01234567","issuance_date":"2025-08-15","income_year":2024,"reference_income":30000,"document_type":"Avis d'impôts sur le revenu","2d_doc":{"full_name_1":"Doe John","fiscal_number_1":"0312345678901","full_name_2":"Doe Jane","fiscal_number_2":"0398765432109","tax_notice_reference":"2412B01234567","income_year":2024,"reference_income":30000,"parts_count":1}},"checks":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"},"income_year":{"extracted":2024,"expected":2024,"match_level":"exact"}}}}},"schema":{"$ref":"#/components/schemas/post_document_analyses_201_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Document Trust Analysis","tags":["Document Trust Analysis"]}},"/documents":{"post":{"deprecated":true,"description":"Deprecated endpoint, do not use.","operationId":"post-documents","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateDocumentFromMultipart"}}},"description":"Upload a Document"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"[DEPRECATED] Upload a Document","tags":["Deprecated"],"x-readme":{"samples-enabled":false,"explorer-enabled":false}}},"/electronic_seal_documents":{"post":{"description":"Create an Electronic Seal Document.\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file.\n- 📝 `application/json` — create from a JSON payload referencing a previously sealed source document.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Electronic Seal` or `Advanced Electronic Seal` or `Qualified Electronic Seal`\n","operationId":"upload-electronic_seal-document","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateElectronicSealDocument"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateElectronicSealDocumentFromJson"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicSealDocument"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create an Electronic Seal Document","tags":["Electronic Seal Document"]}},"/electronic_seal_documents/{electronicSealDocumentId}":{"delete":{"description":"Permanently deletes an Electronic Seal Document attached to an Electronic Seal. This action is only possible when the eSeal is in done or error status. Not applicable to documents sealed with a Qualified eSeal. Warning: this operation is irreversible: once deleted, the document cannot be retrieved. The customer assumes full responsibility for this action.\n","operationId":"delete-electronic_seal_documents-id","parameters":[{"description":"Electronic Seal Document Id","in":"path","name":"electronicSealDocumentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete an Electronic Seal Document","tags":["Electronic Seal Document"]}},"/electronic_seal_documents/{electronicSealDocumentId}/download":{"get":{"description":"Download a given Electronic Seal Document.","operationId":"download-electronic-seal-document","parameters":[{"description":"Electronic Seal Document Id","in":"path","name":"electronicSealDocumentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download an Electronic Seal Document","tags":["Electronic Seal Document"]}},"/electronic_seal_images":{"get":{"description":"Lists Electronic Seal Images.\nThe list is paginated and can be filtered by the `after` cursor.\n","operationId":"list-electronic_seal-images","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_electronic_seal_images_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Electronic Seal Images","tags":["Electronic Seal"]},"post":{"description":"Upload an Electronic Seal Image to use for creating an Electronic Seal (can be used for several Electronic Seals).","operationId":"upload-electronic_seal-image","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadElectronicSealImage"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicSealImage"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Upload an Electronic Seal Image","tags":["Electronic Seal Image"]}},"/electronic_seal_images/preview":{"post":{"description":"Generate a PNG preview of an Electronic Seal Image based on the given field dimensions,\nan optional uploaded image, and an optional caption.\nThis allows integrators to visualize the seal rendering before creating an Electronic Seal.\n\n**This endpoint is only available in Sandbox environment.**\n","operationId":"post-electronic_seal_images-preview","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateElectronicSealImagePreviewPayload"}}},"required":true},"responses":{"200":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Generate an Electronic Seal Image Preview","tags":["Electronic Seal Image"]}},"/electronic_seal_images/{electronicSealImageId}":{"delete":{"description":"Deletes a given Electronic Seal Image.","operationId":"delete-electronic-seal-image","parameters":[{"description":"Electronic Seal Image Id","in":"path","name":"electronicSealImageId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete an Electronic Seal Image","tags":["Electronic Seal Image"]}},"/electronic_seal_images/{electronicSealImageId}/download":{"get":{"description":"Download a given Electronic Seal Image.","operationId":"download-electronic-seal-image","parameters":[{"description":"Electronic Seal Image Id","in":"path","name":"electronicSealImageId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"image/png":{"schema":{"format":"binary","type":"string"}},"image/jpg":{"schema":{"format":"binary","type":"string"}},"image/gif":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download an Electronic Seal Image","tags":["Electronic Seal Image"]}},"/electronic_seals":{"post":{"description":"Create a new Electronic Seal","operationId":"post-electronic-seals","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateElectronicSealPayload"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicSeal"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create an Electronic Seal","tags":["Electronic Seal"]}},"/electronic_seals/{electronicSealId}":{"get":{"description":"Retrieves a given Electronic Seal.","operationId":"get-electronic-seal","parameters":[{"description":"Electronic Seal Id","in":"path","name":"electronicSealId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicSeal"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get an Electronic Seal","tags":["Electronic Seal"]}},"/electronic_seals/{electronicSealId}/audit_trails":{"get":{"description":"Electronic Seal Audit Trail is only available when the Electronic Seal is \"done\".","operationId":"get-electronic_seal-audit_trail","parameters":[{"description":"Electronic Seal Id","in":"path","name":"electronicSealId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElectronicSealAuditTrail"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get an Electronic Seal Audit Trail","tags":["Electronic Seal Audit Trail"]}},"/electronic_seals/{electronicSealId}/audit_trails/download":{"get":{"description":"Electronic Seal Audit Trail is only available when the Electronic Seal is \"done\".","operationId":"download-electronic_seal-audit_trail","parameters":[{"description":"Electronic Seal Id","in":"path","name":"electronicSealId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download an Electronic Seal Audit Trail","tags":["Electronic Seal Audit Trail"]}},"/labels":{"get":{"description":"Returns the list of all the Labels within your organization.","operationId":"get-labels","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `name`. Allowed operators: `eq`, `in`.\nExample: `name[eq]=Miscellaneous`\n","example":{"eq":["Miscellaneous"]},"explode":true,"in":"query","name":"name","required":false,"schema":{"description":"Filter by name.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_labels_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Labels","tags":["Label"]},"post":{"description":"Creates a new Label in the organization.","operationId":"post-labels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLabel"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Label","tags":["Label"]}},"/labels/{labelId}":{"delete":{"description":"Deletes a given Label. This will remove the Label from all Signature Requests it is associated with.","operationId":"delete-labels-id","parameters":[{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Label","tags":["Label"]},"get":{"description":"Retrieves a given Label within your organization.","operationId":"get-labels-id","parameters":[{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Label","tags":["Label"]},"patch":{"description":"Updates a given Label.\nAny parameters not provided are left unchanged.\n","operationId":"patch-label-id","parameters":[{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLabel"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Label","tags":["Label"]}},"/signature_requests":{"get":{"description":"Returns the list of all Signatures Requests in your organization. You can limit the number of items returned by using filters and pagination. Consult our guide for more details and examples.","operationId":"get-signature_requests","parameters":[{"description":"Cursor for pagination; pass the `meta.next_cursor` value from the previous response to fetch the next page.","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`, `in`.\nExample: `status[in]=draft,done`\n","example":{"eq":["draft"],"in":["draft","done"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `created_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `created_at[between]=2025-03-02,2025-03-04`\n","example":{"between":["2025-03-02","2025-03-04"],"before":["2025-03-02"]},"explode":true,"in":"query","name":"created_at","required":false,"schema":{"description":"Filter by date of creation.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `activated_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `activated_at[after]=2025-03-01`\n","example":{"after":["2025-03-01"]},"explode":true,"in":"query","name":"activated_at","required":false,"schema":{"description":"Filter by activation date.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `completed_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `completed_at[between]=2025-03-01,2025-03-31`\n","example":{"between":["2025-03-01","2025-03-31"]},"explode":true,"in":"query","name":"completed_at","required":false,"schema":{"description":"Filter by completion date.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `approved_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `approved_at[after]=2025-03-01`\n","example":{"after":["2025-03-01"]},"explode":true,"in":"query","name":"approved_at","required":false,"schema":{"description":"Filter by approval date.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `rejected_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `rejected_at[before]=2025-04-01`\n","example":{"before":["2025-04-01"]},"explode":true,"in":"query","name":"rejected_at","required":false,"schema":{"description":"Filter by rejection date.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `declined_at`. Allowed operators: `eq`, `between`, `before`, `after`.\nFormat: the date format required is `yyyy-mm-dd`\nExample: `declined_at[after]=2025-01-01`\n","example":{"after":["2025-01-01"]},"explode":true,"in":"query","name":"declined_at","required":false,"schema":{"description":"Filter by decline date.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `external_id`. Allowed operators: `eq`.\nExample: `external_id[eq]=an-external-id`\n","example":{"eq":["an-external-id"]},"explode":true,"in":"query","name":"external_id","required":false,"schema":{"description":"Filter by external_id.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `source`. Allowed operators: `eq`, `in`.\nDefault value: `source[eq]=public_api`. If not specified, only Signature Requests created via the Public API are returned.\nExample: `source[in]=public_api,app`\n","example":{"eq":["public_api"],"in":["public_api","app"]},"explode":true,"in":"query","name":"source","required":false,"schema":{"description":"Filter by source.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Free-text search on the Signature Request name.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Case-sensitive filter by Label name. Allowed operators: `eq`, `in`.\nExample: `label.name[in]=To Sign,Miscellaneous`\n","example":{"eq":["To Sign"],"in":["To Sign","Miscellaneous"]},"explode":true,"in":"query","name":"label.name","required":false,"schema":{"description":"Case sensitive filter by Label's name.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signature Requests","tags":["Signature Request"]},"post":{"description":"Creates a new Signature Request resource.","operationId":"post-signature_requests","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSignatureRequest"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}":{"delete":{"description":"Deletes a given Signature Request, not possible if the Signature Request is in `approval` and `ongoing` status.","operationId":"delete-signature_requests-signatureRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"If true it will permanently delete the Signature Request. It will no longer be retrievable.","in":"query","name":"permanent_delete","schema":{"default":false,"type":"boolean"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Signature Request","tags":["Signature Request"]},"get":{"description":"Retrieves a given Signature Request.","operationId":"get-signature_requests-signatureRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Fetch a Signature Request","tags":["Signature Request"]},"patch":{"description":"Updates a given Signature Request. Any parameters not provided are left unchanged.","operationId":"patch-signature_requests-signatureRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSignatureRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/activate":{"post":{"description":"Activates a Signature request, so it is not in `draft` status anymore.\nIf the `delivery_mode` is not `null`, activating the Signature Request will trigger the notifications to Approvers/Followers/Signers.\n","operationId":"post-signature_requests-signatureRequestId-activate","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateSignatureRequest"}},"*/*":{}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestActivated"}}},"description":"The Signature Request has been activated","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Activate a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/approvers":{"get":{"description":"Returns a list of Approvers for a given Signature Request.","operationId":"get-signature_requests-id-approvers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Approver"},"type":"array"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signature Request's Approvers","tags":["Approver"]},"post":{"description":"Adds an Approver to a given Signature Request.","operationId":"post-signature_requests-signatureRequestId-approvers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApprover"}}},"description":"An Approver object to be added to the Signature Request."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Approver"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Approver","tags":["Approver"]}},"/signature_requests/{signatureRequestId}/approvers/{approverId}":{"delete":{"description":"Deletes a given Approver from a Signature Request.","operationId":"delete-signature_requests-signatureRequestId-approvers-approverId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Approver Id","in":"path","name":"approverId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete an Approver","tags":["Approver"]},"get":{"description":"Retrieves a given Approver.","operationId":"get-signature_requests-signatureRequestId-approvers-approverId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Approver Id","in":"path","name":"approverId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Approver"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get an Approver","tags":["Approver"]},"patch":{"description":"Updates a given Approver. Any parameters not provided are left unchanged.","operationId":"patch-signature_requests-signatureRequestId-approvers-approverId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Approver Id","in":"path","name":"approverId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApprover"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Approver"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update an Approver","tags":["Approver"]}},"/signature_requests/{signatureRequestId}/approvers/{approverId}/send_reminder":{"post":{"description":"Sends a reminder to a given Approver to review their Signature Request.\nOnly possible when the Signature Request status is `approval` and the Approver status is `notified`.\n","operationId":"post-signature_requests-signatureRequestId-approvers-approverId-send_reminder","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Approver Id","in":"path","name":"approverId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"201":{"description":"Reminder has been sent.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Send manual reminder to an Approver","tags":["Approver"]}},"/signature_requests/{signatureRequestId}/audit_trails/download":{"get":{"description":"Download the PDF version of all the Audit Trails attached to a given Signature Request. Each Audit Trail is bound to a different Signer. Only possible when the Signature Request status is `done`.","operationId":"get-signature_requests-signatureRequestId-audit_trails-download","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Download all Audit Trails merged as a single PDF file","in":"query","name":"merge","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/zip, application/pdf":{"schema":{"description":"Binary download: a single `application/pdf` when `merge=true`, otherwise an `application/zip` archive of one Audit Trail PDF per Signer.","format":"binary","type":"string"}}},"description":"Return an application/pdf or application/zip archive with all Audit Trails","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download Signature Request Audit Trails","tags":["Audit Trail"]}},"/signature_requests/{signatureRequestId}/cancel":{"post":{"description":"Cancels a Signature Request when it is in `approval` or `ongoing` status. A canceled Signature Request cannot be reactivated.","operationId":"post-signature_requests-signatureRequestId-cancel","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_signature_requests_signatureRequestId_cancel_request"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_signature_requests_signatureRequestId_cancel_201_response"}}},"description":"The Signature Request has been canceled","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Cancel a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/consent_requests":{"get":{"description":"Returns a list of Signer Consent Requests for a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-signer_consent_requests","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_signer_consent_requests_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signer Consent Requests of the Signature Request","tags":["Signer Consent Request"]},"post":{"description":"Adds a Signer Consent Request to a given Signature Request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"post-signature_requests-signatureRequestId-consent_requests","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSignerConsentRequest"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerConsentRequest"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Add Signer Consent Request to a Signature Request","tags":["Signer Consent Request"]}},"/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}":{"delete":{"description":"Delete a Signer Consent Request from signature request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"delete-signature_requests-signatureRequestId-consent_requests-consentRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Consent Request Id","in":"path","name":"consentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Signer Consent Request","tags":["Signer Consent Request"]},"patch":{"description":"Updates a given Signer Consent Request.\nAny parameters not provided are left unchanged.\nThis action is only permitted when the Signature Request is a draft or paused.\n","operationId":"patch-signature_requests-signatureRequestId-consent_requests-consentRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Consent Request Id","in":"path","name":"consentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSignerConsentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerConsentRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Signer Consent Request","tags":["Signer Consent Request"]}},"/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}/signers/{signerId}":{"delete":{"description":"Remove a Signer from a given Signer Consent Request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"delete-signature_requests-signatureRequestId-consent_requests-consentRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Consent Request Id","in":"path","name":"consentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Remove a Signer from a given Signer Consent Request","tags":["Signer Consent Request"]},"put":{"description":"Adds a Signer to a given Signer Consent Request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"put-signature_requests-signatureRequestId-consent_requests-consentRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Consent Request Id","in":"path","name":"consentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The Signer has been added successfully to Signer Consent Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Adds a Signer to a given Signer Consent Request","tags":["Signer Consent Request"]}},"/signature_requests/{signatureRequestId}/document_requests":{"get":{"description":"Returns a list of Signer Document Requests for a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-signer_document_requests","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_signer_document_requests_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signer Document Requests of the Signature Request","tags":["Signer Document Request"]},"post":{"description":"Adds a Signer Document Request to a given Signature Request.","operationId":"post-signature_requests-signatureRequestId-document_requests","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSignerDocumentRequest"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerDocumentRequest"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Add Signer Document Request to a Signature Request","tags":["Signer Document Request"],"x-readme":{"explorer-enabled":false}}},"/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}":{"delete":{"description":"Delete a Signer Document Request from signature request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"delete-signature_requests-signatureRequestId-document_requests-documentRequestId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Document Request Id","in":"path","name":"documentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Signer Document Request","tags":["Signer Document Request"]},"patch":{"description":"Updates a given Signer Document Request.\nAny parameters not provided are left unchanged.\nThis action is only permitted when the Signature Request is a draft or paused.\n","operationId":"patch-signature_requests-id-document_requests-id","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Document Request Id","in":"path","name":"documentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSignerDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerDocumentRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Signer Document Request","tags":["Signer Document Request"]}},"/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId}":{"delete":{"description":"Remove a Signer from a given Signer Document Request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"delete-signature_requests-signatureRequestId-document_requests-documentRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Document Request Id","in":"path","name":"documentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Remove a Signer from a given Signer Document Request","tags":["Signer Document Request"]},"put":{"description":"Adds a Signer to a given Signer Document Request. This action is only permitted when the Signature Request is a draft or paused.","operationId":"put-signature_requests-signatureRequestId-document_requests-documentRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Document Request Id","in":"path","name":"documentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerDocumentRequest"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Adds a Signer to a given Signer Document Request","tags":["Signer Document Request"]}},"/signature_requests/{signatureRequestId}/documents":{"get":{"description":"Returns a list of Documents for a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-documents","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Filter by `nature`. Allowed operators: `eq`.\nExample: `nature[eq]=attachment` or `nature[eq]=signable_document`.\n","example":{"eq":["attachment"]},"explode":true,"in":"query","name":"nature","required":false,"schema":{"description":"Filter by nature.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Document"},"type":"array"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signature Request's Documents","tags":["Document"]},"post":{"description":"Add a Document to a given Signature Request.\n\n**Limits:** a maximum of 50 Documents can be added per Signature Request.\n\nRelated guide: [Document](https://developers.youtrust.com/docs/document-1)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file (`PDF`, `DOCX`, `JPEG`, `JPG`, `PNG`).\n- 📝 `application/json` — reference an existing Electronic Seal Document by ID.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `plus`, `pro`, `scale`\n- Add-ons (for production access): _none_\n","operationId":"post-signature_requests-signatureRequestId-documents","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/CreateDocumentFromMultipart"}},"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentFromJson"}}},"description":"Sending file with metadata"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Add a Document to a Signature Request","tags":["Document"],"x-readme":{"explorer-enabled":true}}},"/signature_requests/{signatureRequestId}/documents/download":{"get":{"description":"Downloads the PDF version of all Documents attached to a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-documents-download","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Specify Documents version to download, `completed` is only available when the Signature Request status is `done`.","in":"query","name":"version","schema":{"enum":["current","completed"],"type":"string"}},{"description":"Force zip archive download","in":"query","name":"archive","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/zip, application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download Signature Request's Documents","tags":["Document"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}":{"delete":{"description":"Deletes a given Document from a Signature Request.","operationId":"delete-signature_requests-signatureRequestId-documents-documentId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Document","tags":["Document"]},"get":{"description":"Retrieves a given Document.","operationId":"get-signature_requests-signatureRequestId-documents-documentId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Document","tags":["Document"]},"patch":{"description":"Updates a given Document. Any parameters not provided are left unchanged.","operationId":"patch-signature_requests-signatureRequestId-documents-documentId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocument"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Document","tags":["Document"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}/download":{"get":{"description":"Downloads the PDF version of a given Document.","operationId":"get-signature_requests-signatureRequestId-documents-documents-id-download","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download a single Signature Request's Document","tags":["Document"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}/fields":{"get":{"description":"Returns a list of Fields for a given Document. You can limit the number of items returned by using filters.","operationId":"get-signature_requests-signatureRequestId-documents-documentId-fields","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document ID","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `type`. Allowed operators: `eq`, `in`.\nExample: `type[in]=text,checkbox`\n","example":{"eq":["text"],"in":["text","checkbox"]},"explode":true,"in":"query","name":"type","required":false,"schema":{"description":"Filter by type.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `signer_id`. Allowed operators: `eq`.\nExample: `signer_id[eq]=500800fc-3f91-4e86-a9c9-866809a1e3c9`\n","example":{"eq":["500800fc-3f91-4e86-a9c9-866809a1e3c9"]},"explode":true,"in":"query","name":"signer_id","required":false,"schema":{"description":"Filter by signer_id.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `name`. Allowed operators: `eq`.\nExample: `name[eq]=text 1`\n","example":{"eq":["text 1"]},"explode":true,"in":"query","name":"name","required":false,"schema":{"description":"Filter by name.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_documents_documentId_fields_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Lists the Fields of a Signature Request Document.","tags":["Field"]},"post":{"description":"Adds a Field to a given Document.","operationId":"post-signature_requests-signatureRequestId-documents-documentId-fields","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document ID","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateField"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Field on a Document","tags":["Field"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}":{"delete":{"description":"Deletes a given Field from a Document.","operationId":"delete-signature_requests-signatureRequestId-documents-documentId-fields-fieldId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Field Id","in":"path","name":"fieldId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Field","tags":["Field"]},"patch":{"description":"Updates a given Field. Any parameters not provided are left unchanged.","operationId":"update-signature_requests-signatureRequestId-documents-documentId-fields-fieldId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Field Id","in":"path","name":"fieldId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateField"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner"}}},"description":"The Field has been successfully updated.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Field","tags":["Field"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId}/answer":{"post":{"description":"This endpoint can be used on ongoing Signature Requests only.\nIt aims to fill a Field value with a Signer input collected in your custom signing interface. The Fields compatible are Text Fields, Checkboxes and Radio Groups.\n","operationId":"signature_requests-id-documents-id-fields-id-answer","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Field Id","in":"path","name":"fieldId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldAnswer"}}}},"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Answer a Field","tags":["Field"]}},"/signature_requests/{signatureRequestId}/documents/{documentId}/replace":{"post":{"description":"Replace the file of a given Document.","operationId":"post-signature_requests-signatureRequestId-documents-documentId-replace","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/post_signature_requests_signatureRequestId_documents_documentId_replace_request"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Replace a Document in a Signature Request","tags":["Document"]}},"/signature_requests/{signatureRequestId}/embedded_preparation_link":{"get":{"description":"Returns a short-lived link opening the Signature Request Embedded Preparation. The Signature Request must be in `draft` status, have at least one Signer and one Signable Document, and must not have Document visibility restrictions.","operationId":"get-signature_requests-id-embedded_preparation_link","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Language of the Signature Request Embedded Preparation UI. Defaults to the organization's language.","in":"query","name":"locale","required":false,"schema":{"enum":["de","en","es","fr","it","nl","pl"],"example":"fr","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedPreparationLink"}}},"description":"Signature Request Embedded Preparation link generated successfully.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieves an Embedded Preparation Link for a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/followers":{"get":{"description":"Returns a list of Followers for a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-followers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_followers_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List the Signature Request's Followers","tags":["Follower"]},"post":{"description":"Adds a Follower to a given Signature Request.","operationId":"post-signature_requests-signatureRequestId-followers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFollowers"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"description":"A list of Followers added to the Signature Request.","items":{"$ref":"#/components/schemas/Follower"},"type":"array"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create new Followers","tags":["Follower"]}},"/signature_requests/{signatureRequestId}/labels":{"get":{"description":"Returns the list of Labels associated with a given Signature Request.","operationId":"get-signature_requests-id-labels","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_id_labels_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Labels of a Signature Request","tags":["Label"]}},"/signature_requests/{signatureRequestId}/labels/{labelId}":{"delete":{"description":"Removes a Label from a given Signature Request.","operationId":"delete-signature_requests-id-labels-id","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Remove Label from a Signature Request","tags":["Label"]},"put":{"description":"Associates a Label with a given Signature Request.","operationId":"put-signature_requests-id-labels-id","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Associate a Label with a Signature Request","tags":["Label"]}},"/signature_requests/{signatureRequestId}/metadata":{"delete":{"description":"Deletes the Metadata of a given Signature Request.","operationId":"delete-signature_requests-signatureRequestId-metadata","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete the Signature Request Metadata","tags":["Metadata"]},"get":{"description":"Retrieves the Metadata of a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-metadata","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get the Signature Request Metadata","tags":["Metadata"]},"post":{"description":"Add Metadata to a given Signature Request.","operationId":"post-signature_requests-signatureRequestId-metadata","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Attach Metadata to a Signature Request","tags":["Metadata"]},"put":{"description":"Updates the Metadata of a given Signature Request. Any parameters not provided are left unchanged.","operationId":"put-signature_requests-signatureRequestId-metadata","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}},"description":"Updated","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update Metadata of a Signature Request","tags":["Metadata"]}},"/signature_requests/{signatureRequestId}/pause":{"post":{"description":"Pauses a Signature Request when it is in `approval` or `ongoing` status. All signers and approvers must be in `initiated` or `notified` status, and no AES or QES signer may have started their identification process. Recipients may have previously opened their signing link. A paused Signature Request can be edited and then resumed.","operationId":"post-signature_requests-id-pause","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_signature_requests_id_pause_201_response"}}},"description":"The Signature Request has been paused","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Pause a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/reactivate":{"post":{"description":"Reactivates a Signature Request when it is in `expired` status.","operationId":"post-signature_requests-signatureRequestId-reactivate","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_signature_requests_signatureRequestId_reactivate_request"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequest"}}},"description":"The Signature Request has been reactivated","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Reactivate an expired Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/resume":{"post":{"description":"Resumes a Signature Request when it is in paused status. The request is moved to either ongoing or approval status depending on its current configuration.","operationId":"post-signature_requests-id-resume","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_signature_requests_id_resume_201_response"}}},"description":"The Signature Request has been resumed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Resume a Signature Request","tags":["Signature Request"]}},"/signature_requests/{signatureRequestId}/signers":{"get":{"description":"Returns a list of Signers for a given Signature Request.","operationId":"get-signature_requests-signatureRequestId-signers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Signer"},"type":"array"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Signature Request's Signers","tags":["Signer"]},"post":{"description":"Adds a Signer to a given Signature Request.","operationId":"post-signature_requests-signatureRequestId-signers","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSigner"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Signer"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Signer","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}":{"delete":{"description":"Deletes a given Signer from a Signature Request.","operationId":"delete-signature_requests-signatureRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Signer","tags":["Signer"]},"get":{"description":"Retrieves a given Signer.","operationId":"get-signers-signersId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Signer"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Signer","tags":["Signer"]},"patch":{"description":"Updates a given Signer.\nAny parameters not provided are left unchanged.\n","operationId":"patch-signature_requests-signatureRequestId-signers-signerId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSigner"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Signer"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Signer","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails":{"get":{"description":"Retrieves the JSON version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`.","operationId":"get-signature_requests-signatureRequestId-signers-signerId-audit_trails","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerAuditTrail"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get Signer Audit Trail","tags":["Audit Trail"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails/download":{"get":{"description":"Download the PDF version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`.","operationId":"get-signers-signerId-audit_trails-download","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Audit Trail PDF","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download Audit Trail PDF","tags":["Audit Trail"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/documents":{"delete":{"description":"Deletes all documents uploaded by a given Signer for a specific Signature Request.\nDeletion is only possible when Signer status is `signed`.\n","operationId":"delete-signature_requests-signatureRequestId-signers-signerId-documents","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete the Documents uploaded by a Signer","tags":["Signer Document Request"]},"get":{"description":"Returns a list of Documents uploaded by a given Signer.\nOnly possible when Signer status is `signed`.\n","operationId":"get-signature_requests-signatureRequestId-signers-signerId-documents","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_signers_signerId_documents_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List the Signer Documents of a Signer","tags":["Signer Document Request"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/documents/{signerDocumentId}/download":{"get":{"description":"Downloads a Document uploaded by a given Signer.\nOnly possible when Signer status is `signed`.\n","operationId":"get-signature_requests-signatureRequestId-signers-signerId-documents-signerDocumentId","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Document Id","in":"path","name":"signerDocumentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download a Signer Document","tags":["Signer Document Request"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/identity_verification":{"post":{"description":"Verifying an identity document for a Signer to know if their document is valid before enabling them to sign using Advanced Electronic Signature.","operationId":"post-signature_requests-id-signers-id-identity_verification","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SignerIdentityVerification"}}}},"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Pre-verify an identity document","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/send_otp":{"post":{"description":"Send a One-Time Password (OTP) to a given Signer. Use this endpoint only if you use your own signing flow.","operationId":"post-signature_requests-signatureRequestId-signers-signerId-send_otp","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Send a One-Time Password (OTP) to a Signer","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/send_reminder":{"post":{"description":"Sends a reminder to a given signer to complete their Signature Request.\nOnly possible when the Signature Request status is `ongoing` and the Signer status is `notified`.\n","operationId":"post-signature_requests-signatureRequestId-signers-signerId-send_reminder","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"201":{"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Send manual reminder to a Signer","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/sign":{"post":{"description":"Sign a Signature Request on behalf of a given Signer.\n\nUse this endpoint if you are integrating [your own signing flow](https://developers.youtrust.com/docs/building-your-own-signing-flow) (Signers won't go through Youtrust's pre-made signing flow).\n\nTo use this endpoint, you must match the following conditions:\n- The Signature Request `delivery_mode` must be set to `none`.\n- The Signature Request must not have any Approver, Signer Document Request or Signer Consent Request.\n- The Signature Request must not have the parameter `signers_allowed_to_decline` set to `true`.\n- The signature level must be `\"Simple eSignature\"`.\n\nRelated guide: [Building your own signing flow](https://developers.youtrust.com/docs/building-your-own-signing-flow#step-3-collect-the-signer-consent-through-your-own-signing-flow)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📝 `application/json` — sign without uploading a signature image.\n- 📁 `multipart/form-data` — upload a signature image alongside the consent payload.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `scale`\n- Add-ons (for production access): _none_\n","operationId":"post-signature_requests-signatureRequestId-signers-signerId-sign","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignerSign"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SignerSignWithUploadedSignatureImage"}}}},"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Sign a Signature Request","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/unblock_identification":{"post":{"description":"Unblock a Signer during a Qualified Electronic Signature in cases where a mismatch was previously detected between the sender-provided first and/or last name and the information on the Signer's ID document.","operationId":"post-signature_requests-id-signers-id-unblock_identification","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Unblock Signer after an identity mismatch","tags":["Signer"]}},"/signature_requests/{signatureRequestId}/signers/{signerId}/verified_identity_proof/download":{"get":{"description":"Download the Verified Identity Proof (PDF) attached to a given Signer for a Qualified e-Signature. Only possible when Signer identification status is accepted. The identification must be recent and a Video Identity Verification.","operationId":"get-signature_requests-id-signers-id-verified_identity_proof-download","parameters":[{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"Verified Identity Proof PDF","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download Verified Identity Proof PDF","tags":["Signer"]}},"/templates":{"get":{"description":"Returns the list of all Templates within your Organization.","operationId":"get-templates","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":10,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_templates_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Templates","tags":["Template"]}},"/users":{"get":{"description":"Returns the list of all the Users within your Organization.","operationId":"get-users","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `email`. Allowed operators: `eq`.\nExample: `email[eq]=user@example.com`\n","example":{"eq":["user@example.com"]},"explode":true,"in":"query","name":"email","required":false,"schema":{"description":"Filter by email.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_users_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Users","tags":["User"]},"post":{"description":"Creates a new application User and sends them an invitation email.","operationId":"post-users","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUser"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new User","tags":["User"]}},"/users/invitations":{"get":{"description":"Returns the list of all the Users Invitations within your Organization.","operationId":"get-invitations","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `email`. Allowed operators: `eq`.\nExample: `email[eq]=user@example.com`\n","example":{"eq":["user@example.com"]},"explode":true,"in":"query","name":"email","required":false,"schema":{"description":"Filter by email.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_invitations_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List User Invitations","tags":["User Invitation"]}},"/users/invitations/{invitationId}":{"get":{"description":"Retrieves a given User Invitation.","operationId":"get-users-invitation-invitationId","parameters":[{"description":"Invitation Id","in":"path","name":"invitationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitation"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get an Invitation","tags":["User Invitation"]}},"/users/{userId}":{"delete":{"description":"Deletes a given User and its Invitation, only possible when the User is in `invited` status.","operationId":"delete-users-userId","parameters":[{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a User","tags":["User"]},"get":{"description":"Retrieves a given User within your Organization.","operationId":"get-users-userId","parameters":[{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a User","tags":["User"]},"patch":{"description":"Updates a given User.\nAny parameters not provided are left unchanged.\n","operationId":"patch-users-userId","parameters":[{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a User","tags":["User"]}},"/users/{userId}/invitation":{"get":{"description":"Retrieves the Invitation of a given User. The Invitation only exists when the User is in `invited` status.","operationId":"get-users-userId-invitation","parameters":[{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitation"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a User Invitation via the User","tags":["User Invitation"]}},"/verifications/bank_account_lookups":{"get":{"description":"Returns the list of all Bank Account Lookup Verifications within your organization.\nYou can limit the number of items returned by using filters and pagination.\nConsult our [guide](https://developers.youtrust.com/docs/bank-account-lookup-verification) for more details and examples.\n","operationId":"get-verifications-bank_account_lookups","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_bank_account_lookups_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Bank Account Lookup Verifications","tags":["Bank Account Lookup Verification"]},"post":{"description":"Initiate a new Bank Account Lookup Verification to check if a bank account exists and belongs to the specified person or company.\n\nRelated guide: [Bank Account Verification](https://developers.youtrust.com/docs/bank-account-lookup-verification)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📝 `application/json` — provide the natural person's bank account details directly, or reference an existing Workflow Session Applicant by ID.\n- 📁 `multipart/form-data` — upload a binary file containing the natural person's bank account details.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Verify - Bank account verification`\n","operationId":"post-verifications-bank_account_lookups","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/post_verifications_bank_account_lookups_request"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InitiateBankAccountLookupWithNaturalPersonFromFile"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"$ref":"#/components/examples/BankAccountLookupExample"}},"schema":{"$ref":"#/components/schemas/BankAccountLookupFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Bank Account Lookup Verification","tags":["Bank Account Lookup Verification"]}},"/verifications/bank_account_lookups/{bankAccountLookupVerificationId}":{"get":{"description":"Retrieve a specific Bank Account Lookup Verification by its ID.\n","operationId":"get-verifications-bank_account_lookups-id","parameters":[{"description":"Bank Account Lookup Verification Id","in":"path","name":"bankAccountLookupVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result - bank account exists and belongs to the specified person","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","created_at":"2025-07-23T18:22:00+00:00","updated_at":"2025-07-23T18:23:00+00:00","status":"verified","status_codes":[],"data_anonymized":false,"applicant_id":null,"data":{"extracted_from_document":null}}},"failed":{"summary":"Failed result - bank account exists but doesn't belong to the specified person","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","created_at":"2025-07-23T18:22:00+00:00","updated_at":"2025-07-23T18:23:00+00:00","status":"failed","status_codes":["BALV_1101"],"data_anonymized":false,"applicant_id":null,"data":{"extracted_from_document":null}}}},"schema":{"$ref":"#/components/schemas/BankAccountLookupFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Bank Account Lookup Verification","tags":["Bank Account Lookup Verification"]}},"/verifications/bank_accounts":{"get":{"description":"Returns the list of all Bank Account Verifications within your organization. You can limit the number of items returned by using filters and pagination. Consult our [guide](https://developers.youtrust.com/docs/bank-account-details-verification) for more details and examples.","operationId":"get-verifications-bank_accounts","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_bank_accounts_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Bank Account Verifications","tags":["Bank Account Verification"]},"post":{"description":"Ask for a Bank Account Verification by sending the file containing the bank account details, such as IBAN and BIC.\n\nA Bank Account Verification can be requested as follows:\n- **Bank Account verification**: This option only checks the validity of the Bank Account document.\n- **Bank Account verification with legal person**: This option checks both:\n  - the validity of the Bank Account document\n  - the coherence between the provided **legal person** names and those on the document.\n- **Bank Account verification with natural person**: This option checks both:\n  - the validity of the Bank Account document\n  - the coherence between the provided **natural person** names and those on the document.\n\nRelated guide: [Bank Account Document Verification](https://developers.youtrust.com/docs/bank-account-details-verification)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file containing the bank account details (IBAN/BIC).\n- 📝 `application/json` — reference an existing Workflow Session Applicant by ID.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Verify - Bank account document check`\n","operationId":"post-verifications-bank_accounts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateBankAccountFromApplicant"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/post_verifications_bank_accounts_request"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"$ref":"#/components/examples/BankAccountExample"}},"schema":{"$ref":"#/components/schemas/BankAccountFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Bank Account Verification","tags":["Bank Account Verification"],"x-readme":{"explorer-enabled":false}}},"/verifications/bank_accounts/{bankAccountVerificationId}":{"get":{"description":"Get the detailed results of a Bank Account Verification.","operationId":"get-verifications-bank_accounts-id","parameters":[{"description":"Bank Account Verification Id","in":"path","name":"bankAccountVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2025-02-12T23:59:59+00:00","updated_at":"2025-02-12T23:59:59+00:00","status":"verified","status_codes":[],"data_anonymized":false,"workflow_session_id":null,"previous_attempt_id":null,"applicant_id":null,"data":{"extracted_from_document":{"iban":"FR7610278030060001478474080","bic":"CMCIFR2A"}}}}},"schema":{"$ref":"#/components/schemas/BankAccountFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Bank Account Verification","tags":["Bank Account Verification"]}},"/verifications/companies":{"get":{"description":"Returns the list of all Company Verifications within your organization. You can limit the number of items returned by using filters and pagination. Consult our [guide](https://developers.youtrust.com/docs/company-verification) for more details and examples.","operationId":"get-verifications-companies","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_companies_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Company Verifications","tags":["Company Verification"]},"post":{"description":"Initiate a new Company Verification by providing the company number or by uploading a document containing company information.\n\nRelated guide: [Company Registry Verification](https://developers.youtrust.com/docs/company-verification).\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📝 `application/json` — provide the company number directly, or reference an existing Workflow Session Applicant by ID.\n- 📁 `multipart/form-data` — upload a binary file containing the company information.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Verify - Company registry verification`\n","operationId":"post-verifications-companies","requestBody":{"content":{"application/json":{"examples":{"france":{"summary":"French company verification","value":{"company_number":"794513986","country_code":"FR","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}},"spain":{"summary":"Spanish company verification","value":{"company_number":"B12345678","country_code":"ES","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}},"luxembourg":{"summary":"Luxembourg company verification","value":{"company_number":"B1234567","country_code":"LU","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}},"italy":{"summary":"Italian company verification","value":{"company_number":"12345678901","country_code":"IT","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}},"germany":{"summary":"German company verification","value":{"company_number":"HRB123456","country_code":"DE","company_name":"Test Company GmbH","zip_code":"10115","street":"Unter den Linden 1","city":"Berlin","register_court":"Amtsgericht Berlin (Charlottenburg)","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}},"with_applicant":{"summary":"Verification linked to an existing Workflow Session Applicant","value":{"applicant_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"}}},"schema":{"$ref":"#/components/schemas/post_verifications_companies_request"}},"multipart/form-data":{"example":{"file":"Binary file","country_code":"FR","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c"},"schema":{"$ref":"#/components/schemas/InitiateCompanyFromFile"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"$ref":"#/components/examples/CompanyExample"}},"schema":{"$ref":"#/components/schemas/CompanyFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Company Verification","tags":["Company Verification"]}},"/verifications/companies/{companyVerificationId}":{"get":{"description":"Get the detailed results of a Company Verification.","operationId":"get-verifications-companies-id","parameters":[{"description":"Company Verification Id","in":"path","name":"companyVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2023-01-01T12:00:00+00:00","updated_at":"2023-01-01T12:00:00+00:00","status":"verified","data_anonymized":false,"workflow_session_id":null,"previous_attempt_id":null,"applicant_id":null,"data":{"extracted_from_document":{"company_number":"794513986","issued_on":"2023-01-01"},"company_information":{"name":"YOUTRUST","trade_name":null,"company_number":"794513986","partial_data":true,"required_document_type":["company_certificate"],"legal_form":{"code":"6CHY","description":"SAS, société par actions simplifiée"},"vat_number":"FR61794513986","activities":[{"code":"62.01","description":"Computer programming activities","classification":"NACE"}],"founded_on":"2013-07-24","ceased_on":null,"active":true,"commercial_registration":{"location":"CAEN","registered_on":"2013-08-01"},"has_workforce":true},"headquarter":{"address_line_1":"AVENUE PIERRE BERTHELOT","address_line_2":null,"postal_code":"14000","city":"CAEN","country_code":"FR"},"legal_representatives":[{"title":"Président","type":"natural_person","first_name":"John","last_name":"Doe","birth_name":"Doe","born_on":"1994-04-20","company_name":null,"company_number":null}]}}}},"schema":{"$ref":"#/components/schemas/CompanyFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Company Verification","tags":["Company Verification"]}},"/verifications/identity_documents":{"get":{"description":"Returns the list of all Identity Document Verifications within your organization. You can limit the number of items returned by using filters and pagination. Consult our [guide](https://developers.youtrust.com/docs/identity-document-verification) for more details and examples.","operationId":"get-verifications-identity_documents","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_identity_documents_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Identity Document Verifications","tags":["Identity Document Verification"]},"post":{"description":"Verify a person's Identity Document by sending the file containing their Identity Document (identity card, passport, residence permit or driving license).\n\nAn Image Identity Verification can be requested as follows:\n- **Verification with names**: This option checks both the validity of the ID document and the coherence between the names provided and those on the document.\n- **Verification without names**: This option only checks the validity of the ID document.\n\nRelated guide: [Image Identity Verification](https://developers.youtrust.com/docs/identity-document-verification)\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file containing the Identity Document.\n- 📝 `application/json` — reference an existing Workflow Session Applicant by ID.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Verify - Image identity verification`\n","operationId":"post-verifications-identity_documents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateIdentityDocumentFromApplicant"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/post_verifications_identity_documents_request"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"$ref":"#/components/examples/IdentityDocumentExample"}},"schema":{"$ref":"#/components/schemas/IdentityDocumentFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Identity Document Verification","tags":["Identity Document Verification"]}},"/verifications/identity_documents/{identityDocumentVerificationId}":{"get":{"description":"Get the detailed results of an Identity Document Verification, including the status of the verification, the reasons in case of rejection and the data extracted from the Identity Document.","operationId":"get-verifications-identity_documents-id","parameters":[{"description":"Identity Document Verification Id","in":"path","name":"identityDocumentVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T23:15:00+00:00","status":"verified","status_codes":[],"data_anonymized":false,"workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":null,"applicant_id":null,"data":{"extracted_from_document":{"first_name":"John","birth_name":"Doe","last_name":"Doe","born_on":"1990-05-15","birth_location":"Paris","gender":"m","full_address":"13 RUE SAINT MARCELIN\nMARSEILLE 10E (13)","type":"id_card","issuing_country_code":"FR","issued_on":"2020-03-01","expired_on":"2030-03-01","document_number":"X4RTBPFW4","mrz":{"line1":"IDFRASIAGRA<<<<<<<<<<<<<<<<<<<133039","line2":"1002133008071GREGOIRE<<REMY8110228M4","line3":"<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"},"national_identification_number":null}}}}},"schema":{"$ref":"#/components/schemas/IdentityDocumentFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve an Identity Document Verification","tags":["Identity Document Verification"]}},"/verifications/identity_videos":{"get":{"description":"Returns the list of all Identity Video Verifications within your organization. You can limit the number of items returned by using filters and pagination. Consult our [guide](https://developers.youtrust.com/docs/video-based-identity-verification) for more details and examples.","operationId":"get-verifications-identity_videos","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `face_recognition`. Allowed operators: `eq`.\nExample: `face_recognition[eq]=true`\n","example":{"eq":[true]},"explode":true,"in":"query","name":"face_recognition","required":false,"schema":{"description":"Filter by face_recognition.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `pvid`. Allowed operators: `eq`.\nExample: `pvid[eq]=true`\n","example":{"eq":[true]},"explode":true,"in":"query","name":"pvid","required":false,"schema":{"description":"Filter by pvid.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_identity_videos_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Identity Video Verifications","tags":["Identity Video Verification"]},"post":{"description":"Request verification of a person's identity by recording their documents and/or themselves.","operationId":"post-verifications-identity_videos","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateIdentityVideo"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T22:59:00+00:00","status":"pending","status_codes":[],"data_anonymized":false,"face_recognition":false,"pvid":false,"verification_url":"https://api.yousign.app/verifications/identity_video_verifications/3e739d04-11f9-4748-9abd-648928b7b8b4/start","data":{"extracted_from_document":null,"evidence":{"document_front_image_url":null,"document_back_image_url":null,"face_image_url":null}}}}},"schema":{"$ref":"#/components/schemas/IdentityVideoFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Identity Video Verification","tags":["Identity Video Verification"]}},"/verifications/identity_videos/{identityVideoVerificationId}":{"get":{"description":"Get the detailed results of an Identity Video Verification.","operationId":"get-verifications-identity_videos-id","parameters":[{"description":"Identity Video Verification Id","in":"path","name":"identityVideoVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","created_at":"2024-01-18T22:59:00+00:00","updated_at":"2024-01-18T23:15:00+00:00","status":"verified","status_codes":[],"data_anonymized":false,"face_recognition":true,"pvid":false,"workflow_session_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","previous_attempt_id":null,"verification_url":"https://api.yousign.app/verifications/identity_video_verifications/3e739d04-11f9-4748-9abd-648928b7b8b4/start","data":{"extracted_from_document":{"full_name":"David Vincent","born_on":"1985-03-15","type":"passport","issuing_country_code":"US","national_identification_number":null},"evidence":{"document_front_image_url":"https://example.com/front.png","document_back_image_url":"https://example.com/back.png","face_image_url":"https://example.com/face.png"}}}}},"schema":{"$ref":"#/components/schemas/IdentityVideoFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve an Identity Video Verification","tags":["Identity Video Verification"]}},"/verifications/proofs_of_address":{"get":{"description":"Returns the list of all Proof of Address Verifications within your organization.\nYou can limit the number of items returned by using filters and pagination.\nConsult our [guide](https://developers.youtrust.com/docs/proof-of-address-verification) for more details and examples.\n","operationId":"get-verifications-proofs_of_address","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_proofs_of_address_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Proof of Address Verifications","tags":["Proof of Address Verification"]},"post":{"description":"Ask for a Proof of Address Verification by sending a supported document type (see our [guide](https://developers.youtrust.com/docs/proof-of-address-verification) for more info).\n\n**ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:**\n- 📁 `multipart/form-data` — upload a binary file containing the proof of address.\n- 📝 `application/json` — reference an existing Workflow Session Applicant by ID.\n\n**🔓 Endpoint access**\n- Environments: `production`, `sandbox`\n- API key scopes: `organization`, `workspace`\n- Plans: `pro`, `scale`\n- Add-ons (for production access): `Verify - Proof of address check`\n","operationId":"post-verifications-proofs_of_address","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateProofOfAddressFromApplicant"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InitiateProofOfAddress"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"$ref":"#/components/examples/ProofOfAddressExample"}},"schema":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Proof of Address Verification","tags":["Proof of Address Verification"],"x-readme":{"explorer-enabled":false}}},"/verifications/proofs_of_address/{proofOfAddressVerificationId}":{"get":{"description":"Get the detailed results of a Proof of Address Verification.","operationId":"get-verifications-proofs_of_address-id","parameters":[{"description":"Proof of Address Verification Id","in":"path","name":"proofOfAddressVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result","value":{"id":"550e8400-e29b-41d4-a716-446655440000","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2025-02-12T23:59:59+00:00","updated_at":"2025-02-12T23:59:59+00:00","status":"verified","status_codes":[],"data_anonymized":false,"workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":null,"applicant_id":null,"data":{"extracted_from_document":{"first_name":"John","last_name":"Doe","full_address":"Rue De Suède Av Pierre Berthelot 14000 CAEN","issued_on":"2022-01-01","document_type":"tax_notice","2d_doc":{"full_name":"John Doe","address":{"line1":"18 rue de Londres","postal_code":"75008","city":"Paris","country_code":"FR"}}}}}}},"schema":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Proof of Address Verification","tags":["Proof of Address Verification"]}},"/verifications/watchlists":{"get":{"description":"Returns the list of all Watchlist Verifications within your organization.\nYou can limit the number of items returned by using filters and pagination.\nConsult our [guide](https://developers.youtrust.com/docs/watchlists-verification) for more details and examples.\n","operationId":"get-verifications-watchlists","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter by `status`. Allowed operators: `eq`.\nExample: `status[eq]=verified`\n","example":{"eq":["verified"]},"explode":true,"in":"query","name":"status","required":false,"schema":{"description":"Filter by status.","minProperties":1,"type":"object"},"style":"deepObject"},{"description":"Filter by `workspace_id`. Allowed operators: `eq`.\nExample: `workspace_id[eq]=9b6ed2f3-244f-487a-baa1-bbe4f51c8748`\n","example":{"eq":["9b6ed2f3-244f-487a-baa1-bbe4f51c8748"]},"explode":true,"in":"query","name":"workspace_id","required":false,"schema":{"description":"Filter by workspace_id.","minProperties":1,"type":"object"},"style":"deepObject"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_verifications_watchlists_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Watchlist Verifications","tags":["Watchlist Verification"]},"post":{"description":"Initiate a verification to check if a person appears on international sanctions lists or as a politically exposed person (PEP).\n","operationId":"post-verifications-watchlists","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateWatchlist"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"pending":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","created_at":"2025-02-12T23:59:59+00:00","updated_at":"2025-02-12T23:59:59+00:00","status":"pending","data_anonymized":false,"data":{"politically_exposed_person":{"active":false,"positions":[]},"sanctions":{"active":false,"records":[]}}}}},"schema":{"$ref":"#/components/schemas/WatchlistFull"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Initiate a new Watchlist Verification","tags":["Watchlist Verification"]}},"/verifications/watchlists/{watchlistVerificationId}":{"get":{"description":"Retrieve a specific Watchlist Verification by its ID.\nReturns details about sanctions and politically exposed person status.\n","operationId":"get-verifications-watchlists-id","parameters":[{"description":"Watchlist Verification Id","in":"path","name":"watchlistVerificationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"examples":{"verified":{"summary":"Verified result - no data was found","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2025-02-12T23:59:59+00:00","updated_at":"2025-02-13T00:00:00+00:00","status":"verified","data_anonymized":false,"workflow_session_id":null,"previous_attempt_id":null,"data":{"politically_exposed_person":{"active":false,"positions":[]},"sanctions":{"active":false,"records":[]}}}},"failed":{"summary":"Failed result - at least 1 PEP or sanction found","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","created_at":"2025-02-12T23:59:59+00:00","updated_at":"2025-02-13T00:00:00+00:00","status":"failed","data_anonymized":false,"workflow_session_id":null,"previous_attempt_id":null,"data":{"politically_exposed_person":{"active":true,"positions":[{"title":"Minister of Finance","active":true,"country_code":"FR","started_on":"2022-05-20","ended_on":null,"sources":[{"name":"Wikidata Politically Exposed Persons","url":"https://www.opensanctions.org/datasets/wd_peps"}]}]},"sanctions":{"active":true,"records":[{"description":"Economic sanctions related to illegal actions","authority":"European Union","country_code":"EU","active":true,"started_on":"2023-09-15","ended_on":null,"sources":[{"name":"EU Consolidated Sanctions List","url":"https://www.opensanctions.org/datasets/eu_fsf"}]}]}}}}},"schema":{"$ref":"#/components/schemas/WatchlistFull"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Retrieve a Watchlist Verification","tags":["Watchlist Verification"]}},"/verifications/{verificationType}/{verificationId}/audit_trail":{"get":{"description":"Downloads the Audit Trail of a given Verification. Only possible when the Verification status is `verified` or `failed`.\n","operationId":"get-verifications-type-id-audit_trail","parameters":[{"description":"Type of the Verification for which to download the audit trail.","in":"path","name":"verificationType","required":true,"schema":{"enum":["companies","identity_documents","identity_videos","bank_accounts","bank_account_connections","bank_account_lookups","proofs_of_address","watchlists"],"type":"string"}},{"description":"Unique identifier of the Verification.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","in":"path","name":"verificationId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Download Verification Audit Trail","tags":["Verification Audit Trail"]}},"/webhooks":{"get":{"description":"Returns the list of all Webhook subscriptions in your Organization.","operationId":"get-webhooks","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WebhookSubscription"},"type":"array"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Webhook subscriptions","tags":["Webhook"]},"post":{"description":"Creates a new Webhook subscription in your organization.","operationId":"post-webhooks-subscriptions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscription"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a Webhook subscription","tags":["Webhook"]}},"/webhooks/{webhookId}":{"delete":{"description":"Deletes a given Webhook subscription.","operationId":"delete-webhooks-webhookId","parameters":[{"description":"Webhook Id","in":"path","name":"webhookId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Webhook subscription","tags":["Webhook"]},"get":{"description":"Retrieves a given Webhook subscription.","operationId":"get-webhooks-webhookId","parameters":[{"description":"Webhook Id","in":"path","name":"webhookId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Webhook subscription","tags":["Webhook"]},"patch":{"description":"Updates a given Webhook subscription.\nAny parameters not provided are left unchanged.\n","operationId":"patch-webhooks-webhookId","parameters":[{"description":"Webhook Id","in":"path","name":"webhookId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscription"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Webhook subscription","tags":["Webhook"]}},"/workflow_sessions":{"get":{"description":"Returns the list of all Workflow Sessions in your organization. You can limit the number of items returned by using filters and pagination.\n","operationId":"get-workflow_sessions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_workflow_sessions_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Workflow Sessions","tags":["Workflow Session"]},"post":{"description":"Creates a new Workflow Session resource.\n","operationId":"post-workflow_sessions","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowSession"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSession"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Workflow Session","tags":["Workflow Session"]}},"/workflow_sessions/{workflowSessionId}":{"get":{"description":"Retrieves a given Workflow Session.\n","operationId":"get-workflow_sessions-id","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSession"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Workflow Session","tags":["Workflow Session"]}},"/workflow_sessions/{workflowSessionId}/applicants":{"get":{"description":"Returns the list of all Applicants for a given Workflow Session.\n","operationId":"get-workflow_sessions-id-applicants","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Filter Applicants by status.","in":"query","name":"status","required":false,"schema":{"enum":["initiated","notified","processed"],"type":"string"}},{"description":"Filter Applicants by parent Applicant.","in":"query","name":"parent_applicant_id","required":false,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_workflow_sessions_id_applicants_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Applicants","tags":["Applicant"]},"post":{"description":"Creates a new Applicant for a given Workflow Session.\n","operationId":"post-workflow_sessions-id-applicants","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowSessionApplicant"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSessionApplicant"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a new Applicant","tags":["Applicant"]}},"/workflow_sessions/{workflowSessionId}/applicants/{applicantId}":{"get":{"description":"Retrieves a given Applicant for a Workflow Session.\n","operationId":"get-workflow_sessions-id-applicants-id","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Applicant Id","in":"path","name":"applicantId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSessionApplicant"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get an Applicant","tags":["Applicant"]},"patch":{"description":"Updates a given Applicant for a Workflow Session.\n","operationId":"patch-workflow_sessions-id-applicants-id","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"Applicant Id","in":"path","name":"applicantId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowSessionApplicant"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSessionApplicant"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update an Applicant","tags":["Applicant"]}},"/workflow_sessions/{workflowSessionId}/links":{"get":{"description":"Generates portal links for all Applicants in a given Workflow Session. A root's link also covers its child Applicants, so child Applicants are not returned as separate entries.\n","operationId":"get-workflow_sessions-id-links","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowSessionLinks"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Generate Workflow Session Links","tags":["Workflow Session"]}},"/workflow_sessions/{workflowSessionId}/resolve_action":{"post":{"description":"Resolve an Action in a Workflow Session. Once resolved, the Action is treated as having a `verified` status within the Action Group.\nThis is only allowed if the related resource is in a `pending`, `failed`, or `inconclusive` status.\n","operationId":"post-workflow_sessions-id-resolve_action","parameters":[{"description":"Workflow Session Id","in":"path","name":"workflowSessionId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveWorkflowSessionAction"}}}},"responses":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Resolve an Action","tags":["Workflow Session"]}},"/workflow_templates":{"get":{"description":"Returns the list of all Workflow Templates in your organization. You can limit the number of items returned by using filters and pagination.\n","operationId":"get-workflow_templates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_workflow_templates_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Workflow Templates","tags":["Workflow Template"]}},"/workspaces":{"get":{"description":"Returns the list of all Workspaces within your Organization.","operationId":"get-workspaces","parameters":[{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_workspaces_200_response"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"List Workspaces","tags":["Workspace"]},"post":{"description":"Creates a new Workspace in the organization.","operationId":"post-workspace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkspace"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"Created","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Create a Workspace","tags":["Workspace"]}},"/workspaces/default":{"get":{"description":"Retrieves the default Workspace.","operationId":"get-workspaces-default","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get the default Workspace","tags":["Workspace"]},"post":{"description":"Marks the given Workspace as default.","operationId":"markWorkspaceAsDefault","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkWorkspaceAsDefault"}}}},"responses":{"204":{"description":"The resource was modified successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Mark the given Workspace as default","tags":["Workspace"]}},"/workspaces/{workspaceId}":{"delete":{"description":"Deletes a given Workspace and transfers everything that is attached to this Workspace to a another specified Workspace.","operationId":"deleteWorkspace","parameters":[{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWorkspace"}}}},"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Delete a Workspace","tags":["Workspace"]},"get":{"description":"Retrieves a given Workspace.","operationId":"get-workspaces-workspaceId","parameters":[{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Get a Workspace","tags":["Workspace"]},"patch":{"description":"Updates a given Workspace.\nAny parameters not provided are left unchanged.\n","operationId":"patch-workspaces-workspaceId","parameters":[{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkspace"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace"}}},"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"415":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Update a Workspace","tags":["Workspace"]}},"/workspaces/{workspaceId}/users/{userId}":{"delete":{"description":"Removes a User from a given Workspace.","operationId":"delete-workspace-workspaceId-users-userId","parameters":[{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Remove a user from a workspace","tags":["User"]},"put":{"description":"Associates a User with a given Workspace.","operationId":"put-workspaces-workspaceId-Users","parameters":[{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}],"responses":{"204":{"description":"The resource was modified successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"405":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"summary":"Associate a user to a workspace","tags":["User"]}}},"components":{"examples":{"BankAccountLookupExample":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","applicant_id":null,"created_at":"2025-07-23T18:22:00+00:00","updated_at":"2025-07-23T18:22:00+00:00","status":"pending","status_codes":[],"data_anonymized":false,"data":{"extracted_from_document":null}}},"BankAccountExample":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","applicant_id":null,"created_at":"2025-07-23T18:22:00+00:00","updated_at":"2025-07-23T18:22:00+00:00","status":"pending","status_codes":[],"data_anonymized":false,"data":{"extracted_from_document":{"iban":null,"bic":null}}}},"CompanyExample":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"aa8c4e74-ad8f-4a10-bd9d-5681bbf23572","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","applicant_id":null,"created_at":"2023-01-01T12:00:00+00:00","updated_at":"2023-01-01T12:00:00+00:00","status":"pending","data_anonymized":false,"data":{"extracted_from_document":{"company_number":null,"issued_on":null},"company_information":{"name":null,"trade_name":null,"company_number":null,"legal_form":{"code":null,"description":null},"vat_number":null,"activities":[],"founded_on":null,"ceased_on":null,"active":null,"commercial_registration":{"location":null,"registered_on":null},"has_workforce":null},"headquarter":{"address_line_1":null,"address_line_2":null,"postal_code":null,"city":null,"country_code":null},"legal_representatives":[],"beneficial_owners":[]}}},"IdentityDocumentExample":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"aa8c4e74-ad8f-4a10-bd9d-5681bbf23572","workspace_id":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","applicant_id":null,"created_at":"2023-01-01T12:00:00+00:00","updated_at":"2023-01-01T12:00:00+00:00","status":"pending","status_codes":[],"data_anonymized":false,"data":{"extracted_from_document":{"first_name":null,"birth_name":null,"last_name":null,"born_on":null,"birth_location":null,"gender":null,"full_address":null,"type":null,"issuing_country_code":null,"issued_on":null,"expired_on":null,"document_number":null,"mrz":{"line1":null,"line2":null,"line3":null},"national_identification_number":null}}}},"ProofOfAddressExample":{"summary":"Pending - Verification Is In Progress: On Creation The Status Is Always Pending","value":{"id":"1b671a64-40d5-491e-99b0-da01ff1f3341","workspace_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","workflow_session_id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","previous_attempt_id":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","applicant_id":null,"created_at":"2023-01-01T12:00:00+00:00","updated_at":"2023-01-01T12:00:00+00:00","status":"pending","status_codes":[],"data_anonymized":false,"data":{"extracted_from_document":{"first_name":null,"last_name":null,"full_address":null,"issued_on":null,"2d_doc":{"full_name":null,"address":{"line1":null,"postal_code":null,"city":null,"country_code":null}}}}}}},"headers":{"rateLimit-limit":{"description":"The maximum number of requests that the consumer is permitted to make in a given period","schema":{"type":"integer"}},"rateLimit-limit-hour":{"description":"The maximum number of requests that the consumer is permitted to make in an hour window","schema":{"type":"integer"}},"rateLimit-limit-minute":{"description":"The maximum number of requests that the consumer is permitted to make in an minute window","schema":{"type":"integer"}},"rateLimit-remaining":{"description":"The number of requests remaining in the current rate limit window","schema":{"type":"integer"}},"rateLimit-remaining-hour":{"description":"The number of requests remaining in the current hour rate limit window","schema":{"type":"integer"}},"rateLimit-remaining-minute":{"description":"The number of requests remaining in the current minute rate limit window","schema":{"type":"integer"}},"rateLimit-reset":{"description":"The remaining time until the rate limit resets in seconds","schema":{"type":"integer"}},"retry-after":{"description":"Retry the request after X seconds","schema":{"type":"integer"}}},"parameters":{"ArchivedFileId":{"description":"ArchivedFileId","in":"path","name":"archivedFileId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"AfterCursor":{"description":"After cursor (pagination)","in":"query","name":"after","required":false,"schema":{"minLength":1,"type":"string"}},"Limit":{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},"CustomPropertyId":{"description":"Custom Property Id","in":"path","name":"customPropertyId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"LabelId":{"description":"Label Id","in":"path","name":"labelId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"SignatureRequestId":{"description":"Signature Request Id","in":"path","name":"signatureRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"ApproverId":{"description":"Approver Id","in":"path","name":"approverId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"SignerConsentRequestId":{"description":"Signer Consent Request Id","in":"path","name":"consentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"SignerId":{"description":"Signer Id","in":"path","name":"signerId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"SignerDocumentRequestId":{"description":"Signer Document Request Id","in":"path","name":"documentRequestId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"DocumentId":{"description":"Document Id","in":"path","name":"documentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"FieldId":{"description":"Field Id","in":"path","name":"fieldId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"SignerDocumentId":{"description":"Signer Document Id","in":"path","name":"signerDocumentId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"LimitMax10":{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":10,"minimum":1,"type":"integer"}},"InvitationId":{"description":"Invitation Id","in":"path","name":"invitationId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"UserId":{"description":"User Id","in":"path","name":"userId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}},"LimitWithDefault10":{"description":"The limit of items count to retrieve.","in":"query","name":"limit","required":false,"schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}},"WorkspaceId":{"description":"Workspace Id","in":"path","name":"workspaceId","required":true,"schema":{"$ref":"#/components/schemas/UUID"}}},"responses":{"BadRequestError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"UnauthorizedError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Access unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"ForbiddenError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}},"description":"Access forbidden","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"NotFoundError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"Resource not found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"MethodNotAllowed":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowed"}}},"description":"This method is not allowed","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"UnsupportedMediaType":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeResponse"}}},"description":"UnsupportedMediaType","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"TooManyRequests":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests, please try again later.","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"},"Retry-After":{"$ref":"#/components/headers/retry-after"}}},"InternalServerError":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError"}}},"description":"Internal Server Error","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"NoContentDelete":{"description":"The resource was deleted successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"NoContent":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}},"NoContentUpdate":{"description":"The resource was modified successfully","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/rateLimit-limit"},"X-RateLimit-Limit-Hour":{"$ref":"#/components/headers/rateLimit-limit-hour"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/rateLimit-limit-minute"},"RateLimit-Remaining":{"$ref":"#/components/headers/rateLimit-remaining"},"X-RateLimit-Remaining-Hour":{"$ref":"#/components/headers/rateLimit-remaining-hour"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/rateLimit-remaining-minute"},"RateLimit-Reset":{"$ref":"#/components/headers/rateLimit-reset"}}}},"schemas":{"UploadArchivedFile":{"properties":{"file":{"description":"File to be uploaded","format":"binary","type":"string"},"workspace_id":{"example":"69120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","nullable":true,"type":"string"},"archive_y":{"nullable":true,"pattern":"^(true|false)?$","type":"string"},"tags":{"description":"Tags for the file","items":{"maxLength":1000,"minLength":1,"pattern":"[^\\x00-\\x1F\\x7F]*","type":"string"},"nullable":true,"type":"array"},"expired_at":{"description":"Expiration date of the file","example":"2024-06-24 09:26:44","nullable":true,"pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01]) ([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$","type":"string"}},"required":["file"],"type":"object"},"ArchivedFile":{"description":"ArchivedFile","properties":{"id":{"example":"21ac9d25-e24d-4564-b964-d67eed561ca9","format":"uuid","minLength":1,"type":"string"},"sha256":{"description":"Sha256 checksum","example":"6ecf29381314217530c02c64a97050a0a6a0944bb974b6b417588277e289aef0","maxLength":64,"minLength":64,"type":"string"},"filename":{"maxLength":255,"minLength":1,"type":"string"},"created_at":{"description":"Creation date of the file","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"expired_at":{"description":"Expiration date of the file","example":"2025-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"},"content_type":{"example":"application/pdf","type":"string"},"size":{"example":123456,"minimum":1,"type":"integer"},"archive_y_identifier":{"description":"Identifier that allows to save the file in an additional storage.","nullable":true,"type":"string"},"tags":{"description":"Tags for the file","items":{"maxLength":1000,"minLength":1,"pattern":"[^\\x00-\\x1F\\x7F]*","type":"string"},"nullable":true,"type":"array"},"workspace_id":{"example":"528e2077-d0c1-4506-acd9-fac35a9cb7b4","format":"uuid","minLength":1,"type":"string"}},"required":["archive_y_identifier","content_type","created_at","expired_at","filename","id","sha256","size","tags","workspace_id"],"title":"ArchivedFile","type":"object"},"UUID":{"description":"The unique identifier for a resource.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"DateYMD":{"example":"2022-12-10","format":"date","type":"string"},"Consumption":{"properties":{"app":{"$ref":"#/components/schemas/Consumption_app"},"api":{"$ref":"#/components/schemas/Consumption_api"},"connector":{"$ref":"#/components/schemas/Consumption_app"}},"required":["api","app","connector"],"type":"object"},"AddonConsumptionsName":{"enum":["bank_account_connection_verification","bank_account_lookup_verification","bank_account_verification","company_verification","company_de_verification","company_it_verification","document_analysis_verification","document_analysis_tax_notice_verification","document_trust_advanced_verification","document_trust_standard_verification","identity_document_verification","identity_video_face_recognition_verification","certified_identity_pvid","identity_video_verification","proof_of_address_verification","watchlist_verification","advanced_electronic_seal","advanced_electronic_signature","advanced_electronic_signature_pre_verified","archiving","electronic_seal","electronic_signature","otp_sms","qualified_electronic_signature_identity_verification","qualified_electronic_signature_saved_identity"],"type":"string"},"AddonConsumption":{"properties":{"name":{"$ref":"#/components/schemas/AddonConsumptionsName"},"start_at":{"description":"Beginning of the addon subscription","example":"2020-05-18T07:25:36Z","format":"date-time","type":"string"},"end_at":{"description":"End of the addon subscription","example":"2020-05-18T07:25:36Z","format":"date-time","type":"string"},"quota":{"minimum":0,"type":"integer"},"consumed":{"minimum":0,"type":"integer"},"provisioned":{"description":"Only available for qualified_electronic_signature_identity_verification and qualified_electronic_signature_saved_identity addons","minimum":0,"type":"integer"}},"required":["consumed","end_at","name","quota","start_at"],"type":"object"},"PaginationWithUpdatedAt":{"description":"Cursor based pagination","properties":{"next_cursor":{"minLength":1,"nullable":true,"type":"string"},"updated_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"}},"required":["next_cursor","updated_at"],"type":"object"},"DetailedConsumption":{"properties":{"source":{"enum":["app","api","connector"],"type":"string"},"type":{"enum":["invited_signers","electronic_seals","identification_attempts","archiving","verifications"],"type":"string"},"level":{"description":"Specifies the level of the consumed eSignature, eSeal and QES identification attempts: simple, advanced, or qualified.\nOnly set when type is either `invited_signer`, `electronic_seals`, `identification_attempts`.\n","enum":["simple","advanced","qualified"],"type":"string"},"verification_type":{"$ref":"#/components/schemas/KycAddonConsumptionsName"},"identification_mode":{"description":"Only set if type is identification_attempts.","enum":["identity_verification","saved_identity"],"type":"string"},"workspace_id":{"description":"Only set if breakdown is set on workspaces.","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","minLength":1,"type":"string"},"value":{"description":"Count of items or file size in case of archiving.","minimum":1,"type":"integer"}},"required":["source","type","value"],"type":"object"},"Pagination":{"description":"Metadata about the response.","properties":{"next_cursor":{"description":"Token to get the next page of results. If `null`, there are no more pages.\n","minLength":1,"nullable":true,"type":"string"}},"required":["next_cursor"],"type":"object"},"ElectronicSealsConsumption":{"properties":{"seal_id":{"example":"0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6","format":"uuid","type":"string"},"document_id":{"example":"37646975-7e73-41f1-be7f-f4d85d181d03","format":"uuid","type":"string"},"seal_level":{"description":"Level of the Electronic Seal applied.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature_external"],"example":"electronic_signature","type":"string"},"created_at":{"description":"Creation time of the record","example":"2024-05-01 12:00:00","type":"string"},"source":{"description":"Origin of the operation.","example":"app","type":"string"},"external_id":{"description":"Optional user-defined identifier.","example":"ext-12345","nullable":true,"type":"string"},"certificate_id":{"example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","nullable":true,"type":"string"},"workspace_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"authentication_key":{"description":"Identifier of the key used for the operation.","example":"authkey_live_2x1s3k9p","nullable":true,"type":"string"},"workspace_name":{"description":"Name of the workspace.","example":"My workspace","type":"string"},"workspace_external_name":{"description":"External name of the workspace.","example":"My workspace","nullable":true,"type":"string"}},"required":["authentication_key","certificate_id","created_at","document_id","external_id","seal_id","seal_level","source","workspace_external_name","workspace_id","workspace_name"],"type":"object"},"IdentificationsConsumption":{"properties":{"created_at":{"description":"Creation time of the record","example":"2024-05-01 12:00:00","type":"string"},"signer_id":{"example":"0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6","format":"uuid","type":"string"},"signer_email":{"example":"test@example.com","type":"string"},"signature_request_id":{"example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","nullable":true,"type":"string"},"signature_request_name":{"example":"Signature Name","type":"string"},"signature_level":{"description":"Level of the Signature Request.","enum":["simple_electronic_signature","advanced_electronic_signature","electronic_signature_with_qualified_certificate","qualified_electronic_signature"],"example":"simple_electronic_signature","type":"string"},"signer_identification":{"description":"Identification of the Signer.","enum":["identity_verification","saved_identity"],"type":"string"},"identified_at":{"description":"Identification time of the signer","example":"2024-05-01 12:00:00","type":"string"},"identification_status":{"description":"Status of the identification.","enum":["succeeded","rejected","expired_after_succeeded"],"example":"rejected","type":"string"},"identification_reasons":{"example":["too_blury"],"items":{"description":"The reasons why the Signer failed to verify their identity.","enum":["bad_internet_connection","document_expiry_date_missing","document_invalid_failed_owner","document_invalid_failed_rule","document_invalid_part_hidden","document_invalid_part_missing","face_identification_invalid","fraud_attempt_detected","identity_firstname_lastname_inversion","identity_firstname_mismatch","identity_firstname_missing","identity_lastname_mismatch","identity_probably_missing_firstname_parts","identity_probably_missing_lastname_parts","identity_probably_too_many_firstname_parts","identity_probably_too_many_lastname_parts","internal_error","video_quality_insufficient","too_blury","document_version_not_accepted","document_not_original","face_identity_inconsistency","altered_materials","unknown"],"type":"string"},"nullable":true,"type":"array"},"sender_id":{"example":"0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6","format":"uuid","nullable":true,"type":"string"},"sender_email":{"example":"test@example.com","nullable":true,"type":"string"},"authentication_key":{"description":"Identifier of the key used for the operation.","example":"authkey_live_2x1s3k9p","nullable":true,"type":"string"},"authentication_key_description":{"description":"Description of the key used for the operation.","nullable":true,"type":"string"},"external_id":{"description":"Optional user-defined identifier.","example":"ext-12345","nullable":true,"type":"string"},"workspace_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","nullable":true,"type":"string"},"workspace_name":{"description":"Name of the workspace.","example":"My workspace","type":"string"},"signer_fullname":{"description":"Full name of the signer.","example":"Jane Doe","type":"string"},"workspace_external_name":{"description":"External name of the workspace.","example":"My workspace","nullable":true,"type":"string"}},"required":["authentication_key","authentication_key_description","created_at","external_id","identification_reasons","identification_status","identified_at","sender_email","sender_id","signature_level","signature_request_id","signature_request_name","signer_email","signer_fullname","signer_id","signer_identification","workspace_external_name","workspace_id","workspace_name"],"type":"object"},"InvitedSignersConsumption":{"properties":{"created_at":{"description":"Creation time of the record","example":"2024-05-01 12:00:00","type":"string"},"signer_id":{"example":"0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6","format":"uuid","type":"string"},"signer_email":{"example":"test@example.com","type":"string"},"signature_request_id":{"example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","nullable":true,"type":"string"},"signature_request_name":{"example":"Signature Name","type":"string"},"signature_level":{"description":"Level of the Signature Request.","enum":["simple_electronic_signature","advanced_electronic_signature","electronic_signature_with_qualified_certificate","qualified_electronic_signature"],"example":"simple_electronic_signature","type":"string"},"sender_id":{"example":"0e8f7f8a-1b2c-4d3e-9f0a-b1c2d3e4f5a6","format":"uuid","nullable":true,"type":"string"},"sender_email":{"example":"test@example.com","nullable":true,"type":"string"},"source":{"description":"Origin of the operation.","example":"app","type":"string"},"connector":{"description":"Signature request origin.","enum":["app","public_api","connector_salesforce_api","hubspot_integration","connector_google_api","connector_zapier_api"],"example":"app","nullable":true,"type":"string"},"authentication_key":{"description":"Identifier of the key used for the operation.","example":"authkey_live_2x1s3k9p","nullable":true,"type":"string"},"authentication_key_description":{"description":"Description of the key used for the operation.","nullable":true,"type":"string"},"external_id":{"description":"Optional user-defined identifier.","example":"ext-12345","nullable":true,"type":"string"},"workspace_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","nullable":true,"type":"string"},"workspace_name":{"description":"Name of the workspace.","example":"My workspace","type":"string"},"signer_fullname":{"description":"Full name of the signer.","example":"Jane Doe","type":"string"},"workspace_external_name":{"description":"External name of the workspace.","example":"My workspace","nullable":true,"type":"string"}},"required":["authentication_key","authentication_key_description","connector","created_at","external_id","sender_email","sender_id","signature_level","signature_request_id","signature_request_name","signer_email","signer_fullname","signer_id","source","workspace_external_name","workspace_id","workspace_name"],"type":"object"},"Contact":{"properties":{"id":{"format":"uuid","type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"format":"email","type":"string"},"locale":{"type":"string"},"phone_number":{"description":"E.164 format","nullable":true,"type":"string"},"company_name":{"nullable":true,"type":"string"},"job_title":{"nullable":true,"type":"string"},"address_line_1":{"nullable":true,"type":"string"},"address_line_2":{"nullable":true,"type":"string"},"address_city":{"nullable":true,"type":"string"},"address_postal_code":{"nullable":true,"type":"string"},"address_country":{"nullable":true,"type":"string"},"workspace_id":{"example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"required":["address_city","address_country","address_line_1","address_line_2","address_postal_code","company_name","email","first_name","id","job_title","last_name","locale","phone_number"],"title":"Contact","type":"object"},"CreateContact":{"properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"example":"john.doe@example.com","format":"email","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"phone_number":{"description":"E.164 format","example":"+41446667700","minLength":1,"type":"string"},"company_name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Youtrust SAS","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"job_title":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Developer","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"address_line_1":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"34 Rue Malfilatre","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"address_line_2":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"1st floor","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"address_city":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Caen","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"address_postal_code":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"14000","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"address_country":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"France","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"workspace_id":{"example":"69120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","nullable":true,"type":"string"}},"required":["email","first_name","last_name","locale"],"type":"object"},"UpdateContact":{"properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"example":"john.doe@example.com","format":"email","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"phone_number":{"description":"E.164 format","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"company_name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Youtrust SAS","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"job_title":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Developer","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address_line_1":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"34 Rue Malfilatre","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address_line_2":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"1st floor","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address_city":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Caen","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address_postal_code":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"14000","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address_country":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"France","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"workspace_id":{"example":"69120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"CustomExperience":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"landing_page_disabled":{"type":"boolean"},"side_panel_disabled":{"type":"boolean"},"background_color":{"nullable":true,"type":"string"},"button_color":{"nullable":true,"type":"string"},"text_color":{"nullable":true,"type":"string"},"text_button_color":{"nullable":true,"type":"string"},"disabled_notifications":{"items":{"$ref":"#/components/schemas/CustomExperience_DisabledNotificationsType"},"type":"array"},"email_logo_disabled":{"type":"boolean"},"email_header_text_disabled":{"type":"boolean"},"email_footer_signature_disabled":{"type":"boolean"},"email_expiration_text_disabled":{"type":"boolean"},"recipients_activity_disabled":{"type":"boolean"},"download_documents_disabled":{"type":"boolean"},"document_navigation_disabled":{"type":"boolean"},"redirect_urls":{"$ref":"#/components/schemas/CustomExperience_redirect_urls"},"embedded_preparation_navigation_bar":{"$ref":"#/components/schemas/CustomExperience_embedded_preparation_navigation_bar"},"logo":{"example":"https://youtrust.com/custom_experience/89120884-d29a-4b1a-ac7b-a9e73a872795/logo","format":"uri","nullable":true,"type":"string"},"source":{"$ref":"#/components/schemas/CustomExperience_Source"},"workspace_id":{"description":"The Workspace the Custom Experience is scoped to, or null if it is Organization-wide.","format":"uuid","nullable":true,"type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"}},"required":["background_color","button_color","created_at","disabled_notifications","document_navigation_disabled","download_documents_disabled","email_expiration_text_disabled","email_footer_signature_disabled","email_header_text_disabled","email_logo_disabled","embedded_preparation_navigation_bar","id","landing_page_disabled","logo","recipients_activity_disabled","redirect_urls","side_panel_disabled","source","text_button_color","text_color","workspace_id"],"type":"object"},"CreateCustomExperience":{"properties":{"name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"landing_page_disabled":{"default":false,"nullable":true,"type":"boolean"},"side_panel_disabled":{"default":false,"nullable":true,"type":"boolean"},"background_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"button_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"text_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"text_button_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"disabled_notifications":{"items":{"$ref":"#/components/schemas/CustomExperience_DisabledNotificationsType"},"nullable":true,"type":"array"},"email_logo_disabled":{"default":false,"nullable":true,"type":"boolean"},"email_header_text_disabled":{"default":false,"nullable":true,"type":"boolean"},"email_footer_signature_disabled":{"default":false,"nullable":true,"type":"boolean"},"email_expiration_text_disabled":{"default":false,"nullable":true,"type":"boolean"},"recipients_activity_disabled":{"default":true,"nullable":true,"type":"boolean"},"download_documents_disabled":{"default":false,"description":"If true, signers won't be able to download documents before signing.","nullable":true,"type":"boolean"},"document_navigation_disabled":{"default":false,"description":"If true and the request contains more than 1 document, signers must read each document before moving to the next.","nullable":true,"type":"boolean"},"redirect_urls":{"$ref":"#/components/schemas/CreateCustomExperience_redirect_urls"},"embedded_preparation_navigation_bar":{"allOf":[{"$ref":"#/components/schemas/CustomExperience_EmbeddedPreparationNavigationBar"}],"default":{"done_button":true,"back_button":false}},"logo_layout":{"$ref":"#/components/schemas/LogoLayout"},"workspace_id":{"description":"If set, scopes the Custom Experience to a single Workspace. If null (default), the Custom Experience is Organization-wide.","format":"uuid","nullable":true,"type":"string"}},"required":["name"],"type":"object"},"UpdateCustomExperience":{"properties":{"name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","format":"safe-string","type":"string"},"landing_page_disabled":{"nullable":true,"type":"boolean"},"side_panel_disabled":{"nullable":true,"type":"boolean"},"background_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"button_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"text_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"text_button_color":{"description":"Hexadecimal color value","example":"#ff0011","nullable":true,"pattern":"^(#[a-f0-9]{3}$)|(#[a-f0-9]{6}$)","type":"string"},"disabled_notifications":{"items":{"$ref":"#/components/schemas/CustomExperience_DisabledNotificationsType"},"nullable":true,"type":"array"},"email_logo_disabled":{"nullable":true,"type":"boolean"},"email_header_text_disabled":{"nullable":true,"type":"boolean"},"email_footer_signature_disabled":{"nullable":true,"type":"boolean"},"email_expiration_text_disabled":{"nullable":true,"type":"boolean"},"recipients_activity_disabled":{"nullable":true,"type":"boolean"},"download_documents_disabled":{"description":"If true, signers won't be able to download documents before signing.","nullable":true,"type":"boolean"},"document_navigation_disabled":{"default":false,"description":"If true and the request contains more than 1 document, signers must read each document before moving to the next.","nullable":true,"type":"boolean"},"redirect_urls":{"$ref":"#/components/schemas/UpdateCustomExperience_redirect_urls"},"embedded_preparation_navigation_bar":{"allOf":[{"$ref":"#/components/schemas/CustomExperience_EmbeddedPreparationNavigationBar"}],"description":"Navigation bar of the Embedded Preparation page.\nAn explicit `null` hides the whole navigation bar and both button settings are then ignored.\nWhen omitted, the current value is kept.\n"},"logo_layout":{"$ref":"#/components/schemas/LogoLayout"},"workspace_id":{"description":"If set, scopes the Custom Experience to a single Workspace. If null, the Custom Experience is Organization-wide. When omitted, the current value is kept.","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"CustomPropertyType":{"enum":["text","list"],"example":"text","type":"string"},"CustomPropertyList":{"properties":{"data":{"description":"List of custom properties.","items":{"$ref":"#/components/schemas/CustomProperty"},"type":"array"},"next_cursor":{"description":"Cursor for the next page.\nNull if no more pages available.\n","nullable":true,"type":"string"}},"required":["data"],"title":"CustomPropertyList","type":"object"},"CreateCustomProperty":{"additionalProperties":false,"properties":{"name":{"description":"Display name of the property.","example":"Document Type","maxLength":255,"minLength":1,"type":"string"},"type":{"description":"Field type. Cannot be changed after creation.\n","enum":["text","list"],"example":"list","type":"string"},"multiple_answer_allowed":{"default":false,"description":"For list type only. Whether multiple options can be selected.\n","type":"boolean"},"default_value":{"description":"For text type only. Default text pre-filled on new SRs.\n","example":"REF-001","nullable":true,"type":"string"},"options":{"description":"For list type only. Selectable options. At least one required.\n","items":{"$ref":"#/components/schemas/CustomPropertyOptionInput"},"minItems":1,"type":"array"},"workspaces":{"description":"List of Workspaces that define where the Custom Property is scoped. If the array is empty, the Custom Property is available to all Workspaces.\n","items":{"$ref":"#/components/schemas/UUID"},"minItems":0,"type":"array","uniqueItems":true}},"required":["name","type"],"title":"CreateCustomProperty","type":"object"},"CustomProperty":{"properties":{"id":{"description":"Unique identifier of the custom property.","format":"uuid","type":"string"},"name":{"description":"Display name of the property.","type":"string"},"type":{"description":"Field type.","enum":["text","list"],"type":"string"},"required":{"description":"Whether users must fill this property before sending the SR via the application (not enforced via API).","type":"boolean"},"multiple_answer_allowed":{"description":"For list type only — whether multiple options can be selected. Null for text type.","nullable":true,"type":"boolean"},"workspace_ids":{"description":"List of workspace IDs where this property is applicable. Null means org-wide.","items":{"$ref":"#/components/schemas/UUID"},"nullable":true,"type":"array"},"default_value":{"description":"For text type only — default text pre-filled on new signature requests. Null for list type.","maxLength":1000,"nullable":true,"type":"string"},"options":{"description":"For list type only: selectable options.\nNull for text type.\n","items":{"$ref":"#/components/schemas/CustomPropertyOption"},"nullable":true,"type":"array"},"created_at":{"description":"Creation timestamp (ISO 8601).","format":"date-time","type":"string"},"updated_at":{"description":"Last update timestamp (ISO 8601).","format":"date-time","type":"string"}},"required":["created_at","id","name","type","updated_at"],"title":"CustomProperty","type":"object"},"UpdateCustomProperty":{"additionalProperties":false,"properties":{"name":{"description":"Display name of the property.","example":"Contract Type","maxLength":255,"minLength":1,"type":"string"},"type":{"description":"Cannot be changed after creation. If provided and different from current type, request is rejected with 400.\n","enum":["text","list"],"type":"string"},"multiple_answer_allowed":{"description":"For list type only. Whether multiple options can be selected.\n","type":"boolean"},"default_value":{"description":"For text type only. Default text pre-filled on new SRs.\n","nullable":true,"type":"string"},"options":{"description":"For list type only. Send the full array to replace all options.\n- Include id for existing options to preserve them (rename/reorder).\n- Omit id for new options.\n- Options not present in the array are removed.\n","items":{"$ref":"#/components/schemas/CustomPropertyOptionUpdate"},"type":"array"},"workspaces":{"description":"List of Workspaces that define where the Custom Property is scoped. If the array is empty, the Custom Property is available to all Workspaces.\n","items":{"$ref":"#/components/schemas/UUID"},"minItems":0,"type":"array","uniqueItems":true}},"title":"UpdateCustomProperty","type":"object"},"DocumentAnalysisMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the Document Analysis has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"created_at":{"description":"Creation date of the Document Analysis.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Document Analysis.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/DocumentAnalysisStatus"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed`.\n\n`DA_1001` is **deprecated**: it is still emitted alongside more specific check-failure codes (e.g. `DA_2001`, `DA_2002`) for backward compatibility. New integrations should rely on the specific codes.\n","example":[],"items":{"enum":["DA_1001","DA_1002","DA_1003","DA_1004","DA_1005","DA_1100","DA_1201","DA_1202","DA_1301","DA_1302","DA_1303","DA_1304","DA_1401","DA_1402","DA_1403","DA_2001","DA_2002","DA_2301","DA_2302","DA_2401","DA_2402","DA_3001","DA_3003","DA_3004"],"type":"string"},"type":"array"},"type":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisType"}],"description":"Type of the analysed document.\n`null` for fraud-only analyses (`analysis_type.extraction` is `false`).\n","nullable":true},"country_code":{"description":"The country code associated with the document analysis.\nNull for document types that don't require a country code.\n","nullable":true,"type":"string","example":null},"data_anonymized":{"description":"Indicates if the personal data extracted from the document has been anonymized.\nIf set to `true`, the personal data has been anonymized and most fields will be NULL.\n","example":false,"type":"boolean"},"analysis_type":{"$ref":"#/components/schemas/AnalysisType"},"fraud_risk_analysis":{"$ref":"#/components/schemas/FraudRiskAnalysis"}},"required":["country_code","created_at","data_anonymized","id","previous_attempt_id","status","status_codes","type","updated_at","workflow_session_id","workspace_id"],"title":"DocumentAnalysisMeta","type":"object"},"InitiateDocumentAnalysisFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisType"}]},"analysis_type":{"$ref":"#/components/schemas/AnalysisType"},"country_code":{"description":"The country code of the document.\nRequired when `type` is `vehicle_registration_document` (accepted: `FR`, `IT`), `tax_notice` (accepted: `FR`, `DE`), `payslip` (accepted: `FR`, `IT`), `invoice` (accepted: `FR`, `IT`, `DE`), `proof_of_address` (accepted: `IT`, `DE`) or `id_document` (accepted: `DE`).\n","enum":["FR","IT","DE"],"example":"FR","type":"string"},"checks":{"$ref":"#/components/schemas/InitiateDocumentAnalysisFromApplicant_checks"}},"required":["applicant_id","type"],"title":"Attach a new Document Analysis to an Applicant","type":"object"},"InitiateDocumentAnalysisFromMultipart":{"oneOf":[{"$ref":"#/components/schemas/InitiateSocialSecurity"},{"$ref":"#/components/schemas/InitiateCompanyCertificate"},{"$ref":"#/components/schemas/InitiateBusinessRegistrationCertificate"},{"$ref":"#/components/schemas/InitiateDriverLicence"},{"$ref":"#/components/schemas/InitiateRNECertificate"},{"$ref":"#/components/schemas/InitiateTemporaryVehicleRegistrationDocument"},{"$ref":"#/components/schemas/InitiateVehicleRegistrationDocument"},{"$ref":"#/components/schemas/InitiateAutoInsuranceClaimsHistory"},{"$ref":"#/components/schemas/InitiateTaxNotice"},{"$ref":"#/components/schemas/InitiatePayslip"},{"$ref":"#/components/schemas/InitiateInvoice"},{"$ref":"#/components/schemas/InitiateProofOfAddress_1"},{"$ref":"#/components/schemas/InitiateIdDocument"},{"$ref":"#/components/schemas/InitiateFraudOnly"}],"type":"object"},"SocialSecurityFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["social_security"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/SocialSecurityExtraction"},"checks":{"$ref":"#/components/schemas/SocialSecurityCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Social Security","type":"object"},"CompanyCertificateFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["company_certificate"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/CompanyCertificateExtraction"},"checks":{"$ref":"#/components/schemas/CompanyCertificateCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Company Certificate","type":"object"},"BusinessRegistrationCertificateFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["business_registration_certificate"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/BusinessRegistrationCertificateExtraction"},"checks":{"$ref":"#/components/schemas/BusinessRegistrationCertificateCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Business Registration Certificate","type":"object"},"DriverLicenceFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["driver_licence"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/DriverLicenceExtraction"},"checks":{"$ref":"#/components/schemas/DriverLicenceCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Driver Licence","type":"object"},"RNECertificateFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["rne_certificate"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/RNECertificateExtraction"},"checks":{"$ref":"#/components/schemas/RNECertificateCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"RNE Certificate","type":"object"},"TemporaryVehicleRegistrationDocumentFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["temporary_vehicle_registration_document"],"type":"string"},"country_code":{"enum":["IT"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction"},"checks":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Temporary Vehicle Registration Document","type":"object"},"VehicleRegistrationDocumentFull":{"oneOf":[{"$ref":"#/components/schemas/French_Vehicle_Registration_Document"},{"$ref":"#/components/schemas/Italian_Vehicle_Registration_Document"}],"title":"Vehicle Registration Document"},"AutoInsuranceClaimsHistoryFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["auto_insurance_claims_history"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryExtraction"},"checks":{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Auto Insurance Claims History","type":"object"},"TaxNoticeFull":{"oneOf":[{"$ref":"#/components/schemas/French_Tax_Notice_Document"},{"$ref":"#/components/schemas/German_Tax_Notice_Document"},{"$ref":"#/components/schemas/Italian_Tax_Notice"}],"title":"Tax Notice"},"PayslipFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["payslip"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/PayslipExtraction"},"checks":{"$ref":"#/components/schemas/PayslipCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Payslip","type":"object"},"InvoiceFull":{"oneOf":[{"$ref":"#/components/schemas/French_Invoice_Document"},{"$ref":"#/components/schemas/Italian_Invoice_Document"},{"$ref":"#/components/schemas/German_Invoice_Document"}],"title":"Invoice Document"},"ProofOfAddressFull":{"oneOf":[{"$ref":"#/components/schemas/Italian_Proof_of_Address_Document"},{"$ref":"#/components/schemas/German_Proof_of_Address_Document"}],"title":"Proof of Address Document"},"IdDocumentFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["id_document"],"type":"string"},"country_code":{"description":"The country code associated with the document analysis.","enum":["DE"],"example":"DE","type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/IdDocumentExtraction"}},"type":"object"}],"required":["country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"ID Document","type":"object"},"FraudOnlyFull":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"description":"Always `null` for a fraud-only analysis (no document type).","nullable":true,"type":"string","example":null},"analysis_type":{"$ref":"#/components/schemas/FraudOnlyFull_allOf_analysis_type"},"fraud_risk_analysis":{"$ref":"#/components/schemas/FraudRiskAnalysis"}},"required":["analysis_type"],"type":"object"}],"description":"Document Analysis run in fraud-only mode (`analysis_type.extraction` is `false`).\nNo document `type` and no extracted data; only the fraud detection result is returned.\n","title":"Fraud Only","type":"object"},"CreateDocumentFromMultipart":{"properties":{"file":{"description":"Binary file. Accepted formats: `PDF`, `DOCX`, `JPEG`, `JPG` and `PNG`. All files are converted to PDF upon upload.","format":"binary","type":"string"},"nature":{"description":"Can take two values: `signable_document` or `attachment`. Files in `JPEG`, `JPG`, and `PNG` format can only be of `attachment` nature.","enum":["attachment","signable_document"],"type":"string"},"insert_after_id":{"description":"Insert just after the position of the specified document id.","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"password":{"example":"MyPa$$word","type":"string"},"name":{"description":"The document name. If not set, will use the uploaded document name. This value should contain any characters except \"\\\", \"/\" and can\\'t start and finish with a space.","example":"file1","maxLength":128,"minLength":1,"pattern":"^(?!\\s)[^\\/\\\\]+(?<!\\s)$","type":"string"},"initials":{"allOf":[{"$ref":"#/components/schemas/InitialsArea"}],"nullable":true,"type":"object"},"parse_anchors":{"default":false,"description":"If true, the system will parse the document exclusively for Signature-type Smart Anchors and automatically generate the required fields.","example":true,"nullable":true,"type":"boolean"},"flatten":{"default":false,"description":"If true, flattens PDF form fields, removing their interactivity/annotations before the document is processed.","example":true,"nullable":true,"type":"boolean"},"excluded_approvers":{"$ref":"#/components/schemas/DocumentExcludedApprovers"},"excluded_signers":{"$ref":"#/components/schemas/DocumentExcludedSigners"}},"required":["file","nature"],"type":"object"},"Document":{"description":"Document to attach to a Signature Request","properties":{"id":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872796","format":"uuid","type":"string"},"filename":{"maxLength":255,"minLength":1,"type":"string"},"nature":{"enum":["attachment","signable_document"],"type":"string"},"content_type":{"example":"application/pdf","type":"string"},"sha256":{"description":"Sha256 checksum","type":"string"},"is_protected":{"type":"boolean"},"is_signed":{"type":"boolean"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"total_pages":{"description":"Number of pages for signable document","minimum":1,"nullable":true,"type":"integer"},"is_locked":{"description":"If protected by password and not yet unlocked","type":"boolean"},"initials":{"$ref":"#/components/schemas/Document_initials"},"total_anchors":{"description":"Number of parsed anchors from the document.","type":"integer"},"excluded_approvers":{"description":"List of Approver IDs who cannot see this Document.\n","items":{"format":"uuid","type":"string"},"type":"array"},"excluded_signers":{"description":"List of Signer IDs who cannot see this Document.\n","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["content_type","created_at","excluded_approvers","excluded_signers","filename","id","initials","is_locked","is_protected","is_signed","nature","sha256","total_anchors","total_pages"],"title":"Document","type":"object"},"CreateElectronicSealDocument":{"properties":{"file":{"description":"Binary file. Accepted formats: PDF.","format":"binary","type":"string"},"password":{"description":"The password required to unlock the document if it is protected.","example":"MyPa$$word","type":"string"}},"required":["file"],"type":"object"},"CreateElectronicSealDocumentFromJson":{"oneOf":[{"$ref":"#/components/schemas/From_Electronic_Seal_Document"},{"$ref":"#/components/schemas/From_Signature_Request_Document"}],"type":"object"},"ElectronicSealDocument":{"properties":{"id":{"example":"1365283d-0ba5-4a08-9a58-9818ef428320","format":"uuid","type":"string"},"total_pages":{"minimum":1,"type":"integer"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"workspace_id":{"description":"Unique identifier of the Workspace in which this Electronic Seal Document is scoped.","example":"ea11f308-4531-42f9-8218-96b37b7ebb19","format":"uuid","type":"string"}},"required":["created_at","id","total_pages","workspace_id"],"type":"object"},"ElectronicSealImage":{"properties":{"id":{"example":"1365283d-0ba5-4a08-9a58-9818ef428320","format":"uuid","type":"string"},"name":{"example":"My seal image","type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"workspace_id":{"description":"Unique identifier of the Workspace in which this Electronic Seal Image is scoped.","example":"ea11f308-4531-42f9-8218-96b37b7ebb19","format":"uuid","type":"string"}},"required":["created_at","id","name","workspace_id"],"type":"object"},"UploadElectronicSealImage":{"properties":{"file":{"description":"Seal Image to be displayed on a sealed Document. Accepted formats: PNG/JPG/GIF, max 500 Ko.","format":"binary","type":"string"},"name":{"description":"Name of the Seal Image.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"My seal image","format":"safe-string","type":"string"}},"required":["file","name"],"type":"object"},"CreateElectronicSealImagePreviewPayload":{"additionalProperties":false,"properties":{"image_id":{"description":"The ID of an existing Electronic Seal Image to use as the visual stamp.","example":"04c9bf7e-e466-4204-97d2-d21cf5b314e4","format":"uuid","nullable":true,"type":"string"},"field":{"$ref":"#/components/schemas/CreateElectronicSealImagePreviewPayload_field"}},"required":["field"],"title":"CreateElectronicSealImagePreviewPayload","type":"object"},"CreateElectronicSealPayload":{"properties":{"document_id":{"description":"Specify which Electronic Seal Document to use for creating an Electronic Seal.","example":"160473f9-156f-4583-848c-cbc3dec49b4a","format":"uuid","type":"string"},"image_id":{"description":"Specify which Electronic Seal Image to use for creating an Electronic Seal.","example":"333fa90a-a629-4708-8fe9-160dcb055a9b","format":"uuid","nullable":true,"type":"string"},"external_id":{"description":"Store a custom id that will be added to webhooks","example":"externalId-123","maxLength":255,"nullable":true,"pattern":"^[\\w\\-@.%+]+$","type":"string"},"fields":{"description":"Fields you want to add to your Document. At least one Seal Field is mandatory.","items":{"$ref":"#/components/schemas/CreateElectronicSealPayload_fields_inner"},"type":"array"},"signature_level":{"description":"Level of Electronic Seal for your Document","enum":["electronic_signature","advanced_electronic_signature"],"nullable":true,"type":"string"},"certificate_id":{"description":"Specify which certificate to use for creating an Electronic Seal (only available for advanced_electronic_signature level).","example":"a3d84df7-b45e-4321-ae9e-7f5397acb225","format":"uuid","nullable":true,"type":"string"}},"required":["document_id","fields"],"title":"CreateElectronicSealPayload","type":"object"},"ElectronicSeal":{"properties":{"id":{"example":"1365283d-0ba5-4a08-9a58-9818ef428320","format":"uuid","type":"string"},"status":{"enum":["pending","processing","done","error"],"example":"pending","type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"document_id":{"example":"37646975-7e73-41f1-be7f-f4d85d181d03","format":"uuid","type":"string"},"timestamp":{"type":"boolean"},"image_id":{"example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","nullable":true,"type":"string"},"external_id":{"description":"Store a custom id that will be added to webhooks","example":"externalId-123","maxLength":255,"nullable":true,"pattern":"^[\\w\\-@.%+]+$","type":"string"},"signature_level":{"enum":["electronic_signature","advanced_electronic_signature"],"example":"electronic_signature","type":"string"},"workspace_id":{"description":"Unique identifier of the Workspace in which this Electronic Seal is scoped.","example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","type":"string"}},"required":["created_at","document_id","external_id","id","image_id","signature_level","status","timestamp","workspace_id"],"title":"ElectronicSeal","type":"object"},"ElectronicSealAuditTrail":{"properties":{"version":{"type":"number"},"classification":{"type":"string"},"organization":{"type":"object"},"seal":{"type":"object"},"document":{"type":"object"}},"required":["classification","document","organization","seal","version"],"type":"object","x-examples":{"example-1":{"version":1,"classification":"Confidential","organization":{"id":"d89a0f7b-bd3f-494d-ab61-71b69f24a3d9","name":"Universalt Music"},"signer":{"id":"44e4b0f8-55c9-48a9-803f-d89957525270","created_at":"2021-07-05 12:21:42.352630","seal_process_completed_at":"2021-07-05 12:21:43.656000","ip_address":"172.18.0.1"},"documents":{"id":"a9534a42-bbc1-4355-b270-58f315eda779","initial_storage_id":"fdad7bcf-73d5-4a73-945d-ba7b738c530b","initial_hash":{"algorithm":"sha256","value":"8decc8571946d4cd70a024949e033a2a2a54377fe9f1c1b944c20f9ee11a9e51"},"mime_type":"application/pdf","seals":[{"reason":"Signed by Yousign","hash":{"algorithm":"sha256","value":"4396f6a9f0554928f7bcc8e645a6441cb432c1606137ac8f3a735aef83946974"},"timestamp":false,"certificate":{"dn":"CN=Yousign, C=FR, O=Yousign, OU=794513986, serialNumber=2019-02-15 10:07:35:938","oid":"1.2.250.1.302.1.7.1.0","generated_at":"2019-02-15 09:07:36.000000","hash":{"algorithm":"sha256","value":"69570e2d5cc2b352b2249ba32b16195722099a89aa35de71ee1e745f771d66c5"},"content":"-----BEGIN CERTIFICATE-----\nMIIF8DCCA9igAwIBAgIIdfWiF8OAJo0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBTSUdOMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTkwMjE1MDg1NzM2WhcNMjIwMjE0\nMDkwNzAwWjBnMRAwDgYDVQQDDAdZb3VzaWduMSAwHgYDVQQFExcyMDE5LTAyLTE1\nIDEwOjA3OjM1OjkzODESMBAGA1UECwwJNzk0NTEzOTg2MRAwDgYDVQQKDAdZb3Vz\naWduMQswCQYDVQQGEwJGUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAIWI+w9xQ9uSt4Lb/l14Yu8yRvCWer06bzm5RFvqgZRiD2Cq2Vx8LNzi0pGCxBdI\nQ9nlWcxCAh67Lp/OygCKpUN2DnNiIiORK5b283VKASlGMy5frVOCKiq2YCz0vA6k\npIqzBP7DKV/CsZ3EqP0uw9C12EH3PrBJGQq4WOZI1Q5Fs2JAhOwfq/wq2orG424y\n0A9+smh8J3DjwSCoMQZrdHd/obK3w8AaTGI535dqWIZ0wKTZBZ7xahGAPGXo9cy9\nUXFtazxWGIcu5uYjRLtlUyialcUgB0db1eyOzFoRJCsaE6s7QgBhQUUfDkXs1UIp\nD0BfB/K2kPxGENm2Uk6WAfcCAwEAAaOCAYYwggGCMAwGA1UdEwEB/wQCMAAwHwYD\nVR0jBBgwFoAUzmRTx3jf2iI16mJGhB48l67NzPUwSwYDVR0gBEQwQjBABgoqgXoB\ngi4BBwEAMDIwMAYIKwYBBQUHAgEWJGh0dHA6Ly95b3VzaWduLmZyL2ZyL3B1Ymxp\nYy9kb2N1bWVudDAgBgNVHSUEGTAXBgorBgEEAYI3CgMMBgkqhkiG9y8BAQUwgbIG\nA1UdHwSBqjCBpzA1oDOgMYYvaHR0cDovL3RtcC55b3VzaWduLmZyL2NybC95b3Vz\naWduc2Fzc2lnbjJjYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAyLnlvdXNpZ24uZnIv\nY3JsL3lvdXNpZ25zYXNzaWduMmNhLmNybDA2oDSgMoYwaHR0cDovL3RtcDMueW91\nc2lnbi5mci9jcmwveW91c2lnbnNhc3NpZ24yY2EuY3JsMB0GA1UdDgQWBBTgXAE8\nONE89UOu8TjrtBH9cbd92jAOBgNVHQ8BAf8EBAMCBkAwDQYJKoZIhvcNAQELBQAD\nggIBAAF+VPpcphjyoU8RvQO14ojWV51wJxsx5ShsvtXPsQ7dBws8XmthuTyyYxtM\nE3dldkJsaQt8vK7/AUURwO7YX7PHVlwIqm2kpNThZ4+sEib3SOivP8vpfIP3mD0+\nIFREI/8adIWYyiYzp1xjuuAoZ6lyg2JsOQ/67nyS+y7sUQ++GfQulb5yjkMytmYs\nPJ0uyjnNAI/+hy4okIY7qgHFZaDGBSqdGU28NZcCEeBLwjcH4ET2Q1LvJ7nkKQMM\ncxw+TXdy7cgIAjdfCymjJ701s43JKI01NFrNZ0I20jTOuh2qB4Kf8fQFwmutTnRM\nP4ZglXsXZkyL9snUWwMSAP9QP13fPD6EDTTshyijvwHb6zbrFg3U7J0m/Sjmqp2A\nzD+pj777dQ2jg0zTJ3WLOosE1/tt60ygK3HhiVnnyM8sdjTrZ6ca9++TgnRthKss\nR35c/1Be3RJtYnar2yn3bA2pklLcjnV8Q3ZSks4ll7XnEI9V8EQSNHkmno7k+asl\nWeQ8eC82fkwCwzXMLBTt1kN+0qXfpvVoSITPSVlOvdCsFCRSC3JMYHUY6c9oUUlV\nCCEBWxe/Vm8R+AG4i3zk9wIoLDLW2eeOx1G61QFtIlgJPbKRLiDZhaGZq1PN8T2o\nD/1S7m9PMISw1hrWHpJM+gZpRLsfRp5EH3ieRFzt24fpIosf\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIGnDCCBISgAwIBAgIIfVpT4jgxW6cwDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyODExWhcNMjYwMTI3\nMTYyODExWjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFNJR04yIFRFU1QgQ0Ex\nEjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV\nBAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBALUsirI2GYG9qu3U2S4V4JI0V9ohNP3W\nEpssSBcepPBV4UPtwAbFGvJqtGO/0nNZO0J7UwUb0sZBnedFl96tRQff3PECyO9k\n1B1/8rK1TbLPQPhTYWlrvX69wHXJFPxf/JkL4l4Lp6nFS80SYlaRj2RHHJ8HDj8S\nP1oULnhW2f2i8AlJwFe34eLJbWgeI5D7UAo59GMQ6bO4aVMaaDWvXsKOn8qmCUwF\ngtQNOqtYyLgURr4qivbjsZEv5H4Ee+wR5J+U6wd9dpIoTV2g1mExNlKVoj9qX9rh\n4al4G80fKNUT8bVnzxmdkDZzuzKm+rNIN6Fnc5CTHu2IcMHcuvKMRvsSJ+0fiz1E\nb/xsKO18Aiy5XOEQFqDrXRKC5AMmF/zB9Fh1Xe7Bi6IQo15NOjOCHLiBTARsMBJ8\nRWTuTv89qnL1lECogFusbptDG4Gu7Y7M13V8gOoGAxBs6uALjoseFZcnLQlIjZCV\nL0xyhrXFCLFnv4gy2+xY1bJNueD3cLFkzaxiCJ4WKesmRIfc6vHaQNl5NpU+9tFb\nU6o01c3fjZUdIh/MR3GFIXNpPsilhl///5aT5h2L98Gmb2q7tqSbFqm5z17MG3uS\ne4zCt+UD7MI8oCF2CELo79xMjtmqEwIf0IU8MxaLaLSZ0J164ZyHwvfIewgBp8XF\nqLn0jrZNiocXAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY\nMBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0\ndHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag\nNKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj\nYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z\nYXNyb290MmNhLmNybDAdBgNVHQ4EFgQUzmRTx3jf2iI16mJGhB48l67NzPUwDgYD\nVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQBZ8ru8LEQ1qzQqG/Rx420f\ncN4YNM1cXV+DwpWOw46Oh9U7BG1i/wYPy6uEZvj/n+nm/MkbajrzTViZnKMRs7Wy\nCWBqvAfl4gcbWvrRzdVwsbd3UbsxD5UD1CkJYl5/4gPvCae6YVCF9WtnH2lSy/Gv\n5bbIfyXF++iNQn+lLe59EhA3WinTql/yk/SPUNVn4/IZ0UWrw1IPS3kmnIal1mk7\npL45n5G51qAHpSbAoTsCeRBJZ6jr38n+FimZahnBZTu4+XycDVicrydpsopQiTt8\nry+mP1b9Nd4eoHR4/F/82w1rNfAM0NJKL8w3qr8lMdxsbANMvW0ixgjRnBpuRRB4\n5iUA5Mb2DbiYJARBoruYqYGya317Gcvtk4w0O48CXR+HPXygHh/63De1JdOUjSc2\nHagr6jp7NKbn/XmWBjWuoG9J9d9sC5U/mgjw5Xjf9jKGuUGz46EtlzzpojVB7fJA\nE2Ye0kOuLANpoTFAI4EJe5nTJz0HsFG3nDshsD9Mb1/kUBSGUDWijL5f0LDqf562\nkTioMpkK7ivZxQksF8+bMId5sUNrDVA/6lhn8tD5gzGacSU7IMfIH3EUKcI1NoWm\nhV+aI8EbXP6251cF74y/tejTUQLdOQ9ut3PsxYmTTDqr8RPI6UZeh2yibzSmgGwU\nfylsTiF/gVGm5cpWCrULCw==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIGnDCCBISgAwIBAgIIT0TY3eM9ut0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyNjE2WhcNMzYwMTI3\nMTYyNjE2WjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFJPT1QyIFRFU1QgQ0Ex\nEjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV\nBAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBALXMHUFwSacaI5TjtMRw4kJ9o1ve/IZo\noj+2HOpW3iqs74cmsYjpHbJD0UAdh3SpdlLFK1/WBf0uEbzn6z7gRfUkEAo5EnHs\nM1iTfCXWDtA+xd9X4h2UAVEdXRzglvOvT275fjI1uj9Zi4Rz95drhlGkZVCDIMuv\n7fazkT868grWSfGSUc2C8d9+kOL4pCKuSanOc/nwD61F+oQ6KeEMtmpbr57Yy+qY\ntaF6ieKiDGn0aDj3yImnA9YqfFlX4mCyn+LmiqrXyEn0Z5iYLbO0wXkyPqhcO9c9\ngS1Y8Y/1AEvxnaLlV3eG402ZYUS6tT27o+tpdCAIx+3zMhNsPI9wXUjlVr/8ts+/\nuOUUCUWoBK3J6R1zG3urCdnuor8xAaWK/OHtvg8rXoXEfi8ujWV3EbiwIwiUHVh4\nrJIE1vhsVPW/sTM9yEjRFks0swyoX6QupEuaZLV4DbmcEbmZ2XIH5Cw2c1qwUTk2\n8vQzKHszLdRb9scnjd3yHsef5ZAHS9hUoFIfG+MzINGm3U6v4exspSw/EshSavVj\nR+gL0l+sdK4L6xe++K++Gpp5xn5cZUJeg4YtdgGju7lMdGpJVVwl0Y8UAEJt9xgC\nMvGctrkoaUuBjOhrGQQITDMsNrtgi28s7rUB6k+yxcaGBBp2PyAIsIe0e1wKGm1N\nHjGtqY0IV1tFAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY\nMBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0\ndHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag\nNKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj\nYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z\nYXNyb290MmNhLmNybDAdBgNVHQ4EFgQUZcQVpO5GVb7OvXVHwDRARhwa+5EwDgYD\nVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQCuxOXQDSYF0RpYQWonRDlU\nZ64IaGJ5buU4tGzf7rAgIQdXbO/VjjfF9UsjnLopNwWkuSJvINm21obYHcoSwvpz\nlwS/3uJCLxaw5q4SVJ4x5rajh/2qtFzcThSh48rcXcqoxAmc6BzQuIOm9cFUD2Ri\nqUJmg5O+CoLuE1b4i+CsCFL3AoWnBHFZ4YtInQBFIRBhMNPICvYOCF6jjgmMxkWU\nM8SEp7FSFfsy/oPI1dt+k9JjHCXhtWO9ndLvvwvLcjqRO3ItiF9IazsNcNLhaIMA\nlvYiQ+jLpckAuTxj7XHQyJSEofTMPr+ZSgQwUc337MJyxPhTDkch5cQBfnC20Usk\nyjdwwaeiwnNMhESwgDa4Oqw5IOmq+VmqtR+9F9yxACrpyph593F1zYwv7ikik5dI\nIYACb2fKLQrcnCfhm0k1Nt9UXoc9mQzFUK0DWJNLeGJo0rfRQh5ZqhcBG2U0KZFQ\nRtQQEf3zXJxQJGlCn1UMZMJswAzfhMTdGPNzyDI2u+9Q8WT7M2f59Idiae2m79uG\nuStRwN7Vnrpa399YXixOpNTz6d0NFBOAq1Nfwy5cnQDCnT9JkrKidrFKyA21b67m\nSfJIpMSPfFbt3g0h7JPWK7OC4Ydydh92e7/IUhtkudKMoazlwSJ7484dE7NyTpol\n62H0sW/1gmFzE6/QmCUR+w==\n-----END CERTIFICATE-----"}}]}}}},"Label":{"properties":{"id":{"description":"Unique identifier of the Label.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":false,"readOnly":true,"type":"string"},"name":{"description":"Name of the Label.","example":"Contracts","maxLength":128,"minLength":1,"nullable":false,"type":"string"},"created_at":{"description":"Creation date of the Label.","example":"2025-02-12T23:59:59Z","format":"date-time","nullable":false,"readOnly":true,"type":"string"}},"required":["created_at","id","name"],"title":"Label","type":"object"},"CreateLabel":{"properties":{"name":{"description":"Name of the Label. Each Label name must be unique within the organization.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email, HTML and URL.\n","example":"Contracts","format":"safe-string","maxLength":128,"minLength":1,"nullable":false,"title":"Name of the Label.","type":"string"}},"required":["name"],"title":"A Label object","type":"object"},"UpdateLabel":{"properties":{"name":{"description":"Name of the Label. Each Label name must be unique within the organization.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email, HTML and URL.\n","example":"Contracts","format":"safe-string","maxLength":128,"minLength":1,"nullable":false,"title":"The name of your Label","type":"string"}},"required":["name"],"title":"A Label object","type":"object"},"SignatureRequestInList":{"properties":{"id":{"description":"Unique identifier of the Signature Request.","example":"89120884-d29a-4b1a-ac7b-a9e73a872795","minLength":1,"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/SignatureRequestStatus"}],"description":"Current status of the Signature Request."},"name":{"description":"Name of the Signature Request.","example":"signature request name","maxLength":128,"minLength":1,"type":"string"},"delivery_mode":{"description":"How recipients are notified: `email` or `none`.","enum":["email","none"],"type":"string"},"created_at":{"description":"Timestamp when the Signature Request was created.","example":"2024-01-18T22:59:00Z","format":"date-time","minLength":1,"type":"string"},"activated_at":{"description":"Timestamp indicating when the Signature Request was activated and made available to its recipients.\\\nReturns `null` if the Signature Request is still in `draft`.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"completed_at":{"description":"Timestamp indicating when the Signature Request reached the `done` status, i.e. all required Signers have signed and all Approvers have approved.\\\nReturns `null` if the Signature Request is not yet complete.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"approved_at":{"description":"Timestamp indicating when all Approvers have approved the Signature Request when custom recipient flow is not enabled.\\\nReturns `null` if no approvers are configured, or if at least one approver has not yet approved, or when `custom_recipient_order` is enabled.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"ordered_signers":{"description":"Enable an ordered workflow, each Signer will be requested to sign in a sequential order","type":"boolean"},"ordered_approvers":{"description":"Enable an ordered workflow, each Approver will be requested to approve in a sequential order","type":"boolean"},"reminder_settings":{"$ref":"#/components/schemas/SignatureRequestInList_reminder_settings"},"timezone":{"$ref":"#/components/schemas/SignatureRequestTimeZone"},"email_custom_note":{"deprecated":true,"description":"Deprecated. Custom note added to notification emails.","example":"Please sign these documents as soon as possible.","nullable":true,"type":"string"},"expiration_date":{"description":"Due date of the Signature Request.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"source":{"description":"Origin channel through which the Signature Request was created.","enum":["app","public_api","hubspot_integration","connector_salesforce_api","connector_google_api","connector_zapier_api"],"type":"string"},"signers":{"description":"List of Signers.","items":{"$ref":"#/components/schemas/SignatureRequestInList_signers_inner"},"type":"array"},"approvers":{"description":"List of Approvers.","items":{"$ref":"#/components/schemas/SignatureRequestInList_approvers_inner"},"type":"array"},"labels":{"description":"Labels associated to the Signature Request","items":{"$ref":"#/components/schemas/SignatureRequestLabel"},"type":"array"},"documents":{"description":"List of Documents attached to the Signature Request.","items":{"$ref":"#/components/schemas/SignatureRequestInList_documents_inner"},"type":"array"},"sender":{"$ref":"#/components/schemas/SignatureRequestInList_sender"},"external_id":{"description":"Custom identifier attached to webhooks and appended to redirect URLs.","example":"An_external-ID","nullable":true,"type":"string"},"branding_id":{"deprecated":true,"description":"Deprecated. Identifier of the branding applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"custom_experience_id":{"description":"Identifier of the Custom Experience applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signers_allowed_to_decline":{"description":"Whether Signers are allowed to decline signing.","example":true,"type":"boolean"},"workspace_id":{"description":"Identifier of the Workspace the Signature Request belongs to.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"audit_trail_locale":{"allOf":[{"$ref":"#/components/schemas/AuditTrailLocale"}],"description":"Locale used for the generated audit trail."},"bulk_send_batch_id":{"description":"Identifier of the bulk send batch, if created via bulk send.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"custom_recipient_order":{"description":"Enable a custom recipients order","type":"boolean"},"custom_properties":{"description":"Custom properties associated with the Signature Request.","items":{"$ref":"#/components/schemas/CustomPropertyInList"},"type":"array"}},"required":["activated_at","approved_at","audit_trail_locale","branding_id","bulk_send_batch_id","completed_at","created_at","custom_experience_id","custom_recipient_order","delivery_mode","documents","email_custom_note","expiration_date","external_id","id","name","ordered_approvers","ordered_signers","previous_attempt_id","reminder_settings","sender","signers","signers_allowed_to_decline","source","status","timezone","workflow_session_id"],"title":"SignatureRequest","type":"object"},"CreateSignatureRequest":{"additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/New_Signature_Request_From_Scratch"},{"$ref":"#/components/schemas/Duplicate_a_Signature_Request"}],"type":"object"},"SignatureRequest":{"properties":{"id":{"description":"Unique identifier of the Signature Request.","example":"89120884-d29a-4b1a-ac7b-a9e73a872795","minLength":1,"type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/SignatureRequestStatus"}],"description":"Current status of the Signature Request."},"name":{"description":"Name of the Signature Request.","example":"signature request name","maxLength":128,"minLength":1,"type":"string"},"delivery_mode":{"description":"How recipients are notified: `email` or `none`.","enum":["email","none"],"type":"string"},"created_at":{"description":"Timestamp when the Signature Request was created.","example":"2024-01-18T22:59:00Z","format":"date-time","minLength":1,"type":"string"},"activated_at":{"description":"Timestamp indicating when the Signature Request was activated and made available to its recipients.\\\nReturns `null` if the Signature Request is still in `draft`.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"completed_at":{"description":"Timestamp indicating when the Signature Request reached the `done` status, i.e. all required Signers have signed and all Approvers have approved.\\\nReturns `null` if the Signature Request is not yet complete.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"approved_at":{"description":"Timestamp indicating when all Approvers have approved the Signature Request when custom recipient flow is not enabled.\\\nReturns `null` if no approvers are configured, or if at least one approver has not yet approved, or when `custom_recipient_order` is enabled.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"ordered_signers":{"description":"Enable an ordered workflow, each Signer will be requested to sign in a sequential order","type":"boolean"},"ordered_approvers":{"description":"Enable an ordered workflow, each Approver will be requested to approve in a sequential order","type":"boolean"},"reminder_settings":{"$ref":"#/components/schemas/SignatureRequest_reminder_settings"},"timezone":{"$ref":"#/components/schemas/SignatureRequestTimeZone"},"email_custom_note":{"deprecated":true,"description":"Deprecated. Custom note added to notification emails.","example":"Please sign these documents as soon as possible.","maxLength":500,"nullable":true,"type":"string"},"expiration_date":{"description":"Due date of the Signature Request.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"source":{"description":"Origin channel through which the Signature Request was created.","enum":["app","public_api","hubspot_integration","connector_salesforce_api","connector_google_api","connector_zapier_api"],"type":"string"},"signers":{"description":"List of Signers.","items":{"$ref":"#/components/schemas/SignatureRequestInList_signers_inner"},"type":"array"},"approvers":{"description":"List of Approvers.","items":{"$ref":"#/components/schemas/SignatureRequestInList_approvers_inner"},"type":"array"},"labels":{"description":"Labels associated to the Signature Request","items":{"$ref":"#/components/schemas/SignatureRequestLabel"},"type":"array"},"documents":{"description":"List of Documents attached to the Signature Request.","items":{"$ref":"#/components/schemas/SignatureRequestInList_documents_inner"},"type":"array"},"sender":{"$ref":"#/components/schemas/SignatureRequestInList_sender"},"external_id":{"description":"Custom identifier attached to webhooks and appended to redirect URLs.","example":"An_external-ID","nullable":true,"type":"string"},"branding_id":{"deprecated":true,"description":"Deprecated. Identifier of the branding applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"custom_experience_id":{"description":"Identifier of the Custom Experience applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signers_allowed_to_decline":{"description":"Whether Signers are allowed to decline signing.","example":true,"type":"boolean"},"workspace_id":{"description":"Identifier of the Workspace the Signature Request belongs to.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"audit_trail_locale":{"allOf":[{"$ref":"#/components/schemas/AuditTrailLocale"}],"description":"Locale used for the generated audit trail."},"email_notification":{"$ref":"#/components/schemas/SignatureRequest_email_notification"},"embedded_preparation":{"$ref":"#/components/schemas/SignatureRequest_embedded_preparation"},"bulk_send_batch_id":{"description":"Identifier of the bulk send batch, if created via bulk send.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"decline_information":{"$ref":"#/components/schemas/SignatureRequest_decline_information"},"rejection_information":{"$ref":"#/components/schemas/SignatureRequest_rejection_information"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"custom_recipient_order":{"description":"Enable a custom recipients order","type":"boolean"},"custom_properties":{"description":"Custom properties associated with the Signature Request.","items":{"$ref":"#/components/schemas/CustomPropertyValue"},"type":"array"}},"required":["activated_at","approved_at","audit_trail_locale","branding_id","bulk_send_batch_id","completed_at","created_at","custom_experience_id","custom_recipient_order","delivery_mode","documents","email_custom_note","email_notification","embedded_preparation","expiration_date","external_id","id","name","ordered_approvers","ordered_signers","previous_attempt_id","rejection_information","reminder_settings","sender","signers","signers_allowed_to_decline","source","status","timezone","workflow_session_id"],"title":"SignatureRequest","type":"object"},"UpdateSignatureRequest":{"properties":{"name":{"description":"Name of the Signature Request.","format":"safe-string","maxLength":128,"minLength":1,"type":"string"},"delivery_mode":{"description":"Delivery mode to notify signers.","enum":["none","email"],"type":"string"},"ordered_signers":{"description":"Enable an ordered workflow, each signer will be requested to sign in a sequential order","example":true,"type":"boolean"},"ordered_approvers":{"description":"When enabled, Approvers are requested to approve sequentially.\nEach Approver will be invited to approve only once the previous one has completed their approval.\n","example":true,"type":"boolean"},"reminder_settings":{"$ref":"#/components/schemas/UpdateSignatureRequest_reminder_settings"},"timezone":{"$ref":"#/components/schemas/SignatureRequestTimeZone"},"email_custom_note":{"deprecated":true,"description":"Deprecated; use `email_notification.custom_text` instead.","example":"Please sign these documents as soon as possible.","format":"safe-string","maxLength":500,"nullable":true,"type":"string"},"expiration_date":{"description":"Due date of the Signature Request (yyyy-mm-dd).\nThe date cannot be in the past and cannot be more than one year after initiation.\n","format":"date","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"external_id":{"description":"Custom identifier added to webhooks and appended to redirect URLs.","maxLength":255,"nullable":true,"pattern":"^[\\w\\-@.%+]+$","type":"string"},"branding_id":{"deprecated":true,"description":"Deprecated. Identifier of the branding to apply; use `custom_experience_id` instead.","example":"3a93d3b5-fb3b-4abf-9e70-26315b33506b","format":"uuid","nullable":true,"type":"string"},"custom_experience_id":{"description":"Use a specific Custom Experience to customize the signature experience.","example":"3a93d3b5-fb3b-4abf-9e70-26315b33506b","format":"uuid","nullable":true,"type":"string"},"signers_allowed_to_decline":{"default":false,"description":"Allowing signers to decline to sign.","example":true,"type":"boolean"},"workspace_id":{"description":"Transfer the Signature Request into a given Workspace.","example":"3a93d3b5-fb3b-4abf-9e70-26315b33506b","format":"uuid","nullable":true,"type":"string"},"audit_trail_locale":{"allOf":[{"$ref":"#/components/schemas/AuditTrailLocale"}],"description":"Define the locale for the generated audit trail.","nullable":true,"type":"string"},"email_notification":{"$ref":"#/components/schemas/SignatureRequest_EmailNotification"},"embedded_preparation":{"$ref":"#/components/schemas/SignatureRequest_EmbeddedPreparation"},"labels":{"description":"List of Labels to associate with the Signature Request. Labels are identified by their ID.","example":["3a93d3b5-fb3b-4abf-9e70-26315b33506b","89120884-d29a-4b1a-ac7b-a9e73a872795"],"items":{"format":"uuid","type":"string"},"maxItems":50,"type":"array"}},"type":"object"},"ActivateSignatureRequest":{"properties":{"sender_id":{"description":"The Id of the User that should be considered as the Signature Request sender.\nThey must be part of the Workspace of the Signature Request and be active.\nMandatory with `sender_type: \"user\"`, must be omitted otherwise.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"type":"object"},"SignatureRequestActivated":{"properties":{"id":{"description":"Unique identifier of the Signature Request.","example":"89120884-d29a-4b1a-ac7b-a9e73a872795","minLength":1,"type":"string"},"status":{"description":"Status after activation: `ongoing` or `approval`.","enum":["ongoing","approval"],"type":"string"},"name":{"description":"Name of the Signature Request.","example":"signature request name","maxLength":128,"minLength":1,"type":"string"},"delivery_mode":{"description":"How recipients are notified: `email` or `none`.","enum":["email","none"],"type":"string"},"created_at":{"description":"Timestamp when the Signature Request was created.","example":"2024-01-18T22:59:00Z","format":"date-time","minLength":1,"type":"string"},"activated_at":{"description":"Timestamp indicating when the Signature Request was activated and made available to its recipients.\\\nReturns `null` if the Signature Request is still in `draft`.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"completed_at":{"description":"Timestamp indicating when the Signature Request reached the `done` status, i.e. all required Signers have signed and all Approvers have approved.\\\nReturns `null` if the Signature Request is not yet complete.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"approved_at":{"description":"Timestamp indicating when all Approvers have approved the Signature Request when custom recipient flow is not enabled.\\\nReturns `null` if no approvers are configured, or if at least one approver has not yet approved, or when `custom_recipient_order` is enabled.\n","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"ordered_signers":{"description":"Enable an ordered workflow, each Signer will be requested to sign in a sequential order","example":true,"type":"boolean"},"ordered_approvers":{"description":"Enable an ordered workflow, each Approver will be requested to approve in a sequential order","example":true,"type":"boolean"},"reminder_settings":{"$ref":"#/components/schemas/SignatureRequest_reminder_settings"},"timezone":{"$ref":"#/components/schemas/SignatureRequestTimeZone"},"email_custom_note":{"deprecated":true,"description":"Deprecated. Custom note added to notification emails.","example":"Please sign these documents as soon as possible.","nullable":true,"type":"string"},"expiration_date":{"description":"Due date of the Signature Request.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"signers":{"description":"List of Signers with their signature links.","items":{"$ref":"#/components/schemas/EmbeddedSignerWithSignatureLink"},"minItems":1,"type":"array","uniqueItems":true},"approvers":{"description":"List of Approvers with their approval links.","items":{"$ref":"#/components/schemas/ApproverToNotify"},"type":"array","uniqueItems":true},"labels":{"description":"Labels associated to the Signature Request","items":{"$ref":"#/components/schemas/SignatureRequestLabel"},"type":"array"},"documents":{"description":"List of Documents attached to the Signature Request.","items":{"$ref":"#/components/schemas/SignatureRequestActivated_documents_inner"},"type":"array"},"external_id":{"description":"Custom identifier attached to webhooks and appended to redirect URLs.","maxLength":255,"nullable":true,"pattern":"^[\\w\\-@.%+]+$","type":"string"},"branding_id":{"description":"Identifier of the branding applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"custom_experience_id":{"description":"Identifier of the Custom Experience applied.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"audit_trail_locale":{"allOf":[{"$ref":"#/components/schemas/AuditTrailLocale"}],"description":"Locale used for the generated audit trail."},"signers_allowed_to_decline":{"description":"Whether Signers are allowed to decline signing.","type":"boolean"},"rejection_information":{"$ref":"#/components/schemas/SignatureRequest_rejection_information"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"custom_recipient_order":{"description":"Enable a custom recipients order","type":"boolean"}},"required":["activated_at","approved_at","audit_trail_locale","branding_id","completed_at","created_at","custom_experience_id","custom_recipient_order","delivery_mode","documents","email_custom_note","expiration_date","external_id","id","name","ordered_approvers","ordered_signers","previous_attempt_id","rejection_information","reminder_settings","signers","signers_allowed_to_decline","status","timezone","workflow_session_id"],"title":"SignatureRequestActivated","type":"object"},"Approver":{"description":"Approver","properties":{"id":{"example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","minLength":1,"type":"string"},"status":{"enum":["initiated","notified","approved","rejected"],"type":"string"},"info":{"$ref":"#/components/schemas/Approver_info"},"approval_link":{"format":"uri","minLength":1,"nullable":true,"type":"string"},"approval_link_expiration_date":{"example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"},"custom_text":{"$ref":"#/components/schemas/CustomText"},"approved_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"},"recipient_stage_index":{"description":"Position of the recipient in the signing flow. Recipients with the same index are notified simultaneously.","type":"integer"},"excluded_documents":{"description":"List of Document IDs not visible to this Approver.\n","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["approval_link","approval_link_expiration_date","approved_at","custom_text","excluded_documents","id","info","recipient_stage_index","status"],"title":"Approver","type":"object"},"CreateApprover":{"oneOf":[{"$ref":"#/components/schemas/New_Approver_From_Scratch"},{"$ref":"#/components/schemas/New_Approver_From_Existing_User"},{"$ref":"#/components/schemas/New_Approver_From_Existing_Contact"},{"$ref":"#/components/schemas/New_Approver_From_Existing_Signer"}],"properties":{"custom_text":{"$ref":"#/components/schemas/CustomText"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be an approver. `ordered_approvers` must be enabled on the Signature Request.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"}},"type":"object"},"UpdateApprover":{"properties":{"info":{"$ref":"#/components/schemas/UpdateApprover_info"},"custom_text":{"$ref":"#/components/schemas/CustomText"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be an approver. `ordered_approvers` must be enabled on the Signature Request.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"}},"type":"object"},"SignatureRequestStatus":{"enum":["draft","ongoing","done","deleted","expired","canceled","approval","rejected","declined","paused"],"type":"string"},"SignerConsentRequest":{"description":"Signer Consent Request attached to a Signature Request","properties":{"id":{"description":"Unique identifier of the Signer Consent Request","example":"69df8404-40d3-4686-887b-5678f46a0d9a","format":"uuid","readOnly":true,"type":"string"},"type":{"description":"Type of the Signer Consent Request","enum":["checkbox","text_to_copy"],"example":"checkbox","type":"string"},"settings":{"$ref":"#/components/schemas/SignerConsentRequest_settings"},"optional":{"description":"Define if the Signer Consent Request is optional for Signers","example":false,"type":"boolean"},"signer_ids":{"description":"Ids of Signers to request a consent","example":["71517741-a4a8-4f25-8496-6e9c6d2b7791","0c42e1ae-1cac-457b-9a09-5fda5f735bd8"],"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"},"document_id":{"description":"The Document id to which it is linked.","example":"9658867a-d2f3-46f0-9bce-36c45f42644e","format":"uuid","nullable":true,"type":"string"}},"required":["document_id","id","optional","settings","signer_ids","type"],"type":"object"},"CreateSignerConsentRequest":{"properties":{"type":{"description":"Type of the Signer Consent Request","enum":["checkbox","text_to_copy"],"example":"checkbox","type":"string"},"settings":{"$ref":"#/components/schemas/CreateSignerConsentRequest_settings"},"optional":{"description":"Define if the Signer Consent Request is optional for Signers","example":false,"type":"boolean"},"signer_ids":{"description":"Ids of Signers to request a consent","example":["71517741-a4a8-4f25-8496-6e9c6d2b7791","0c42e1ae-1cac-457b-9a09-5fda5f735bd8"],"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"},"insert_after_id":{"description":"Insert just after the position of the specified Signer Consent Request id","format":"uuid","nullable":true,"type":"string","example":null},"document_id":{"description":"Link the Signer Consent Request to a given Document by its id.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"required":["optional","settings","signer_ids","type"],"title":"CreateSignerConsentRequest","type":"object"},"UpdateSignerConsentRequest":{"properties":{"settings":{"$ref":"#/components/schemas/CreateSignerConsentRequest_settings"},"optional":{"description":"Define if the Signer Consent Request is optional for Signers","example":false,"type":"boolean"},"insert_after_id":{"description":"Insert just after the position of the specified Signer Consent Request id","format":"uuid","nullable":true,"type":"string","example":null},"document_id":{"description":"Link the Signer Consent Request to a given Document by its id.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"title":"UpdateSignerConsentRequest","type":"object"},"SignerDocumentRequest":{"description":"Signer Document Request attached to a Signature Request","properties":{"id":{"description":"Unique identifier of the Signer Document Request","example":"69df8404-40d3-4686-887b-5678f46a0d9a","format":"uuid","type":"string"},"title":{"description":"Title of the document request","example":"Proof of address","maxLength":255,"minLength":1,"type":"string"},"optional":{"description":"Define if the document request is optional for the Signers","type":"boolean"},"signer_ids":{"description":"Ids of Signers to request a document","items":{"example":"2fd4a3fb-a886-4c9d-ac49-ea6f759c0c64","format":"uuid","type":"string"},"type":"array"}},"required":["id","optional","signer_ids","title"],"type":"object"},"CreateSignerDocumentRequest":{"example":{"title":"Proof of address","optional":true,"signer_ids":["29f6049b-9c9d-4d1d-893c-be24e7d98d13","7d938814-5492-4c02-806e-69c8fc1254ff"]},"properties":{"title":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"optional":{"type":"boolean"},"signer_ids":{"items":{"format":"uuid","type":"string"},"minItems":1,"type":"array"}},"required":["optional","signer_ids","title"],"title":"CreateSignerDocumentRequest","type":"object"},"UpdateSignerDocumentRequest":{"properties":{"title":{"description":"Title of the Signer Document Request.","example":"Proof of address","maxLength":255,"minLength":1,"type":"string"},"optional":{"description":"Define if the document request is optional for the Signers","type":"boolean"}},"type":"object"},"CreateDocumentFromJson":{"properties":{"electronic_seal_document_id":{"description":"Id of the Electronic Seal Document. The Electronic Seal must be done to use its Electronic Seal Document.","example":"672a5a0b-ac65-407e-9da9-d34402bae974","format":"uuid","type":"string"},"name":{"example":"file1","maxLength":128,"minLength":1,"nullable":true,"pattern":"^(?!\\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżß`'() -]+(?<!\\s)$","type":"string"},"nature":{"enum":["attachment","signable_document"],"example":"signable_document","type":"string"},"insert_after_id":{"description":"Insert just after the position of the specified Document id.","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"parse_anchors":{"default":false,"description":"If true, the system will parse the document exclusively for Signature-type Smart Anchors and automatically generate the required fields.","example":true,"nullable":true,"type":"boolean"},"excluded_approvers":{"$ref":"#/components/schemas/DocumentExcludedApprovers"},"excluded_signers":{"$ref":"#/components/schemas/DocumentExcludedSigners"}},"required":["electronic_seal_document_id","nature"],"type":"object"},"UpdateDocument":{"properties":{"nature":{"description":"Files in JPEG, JPG, and PNG format can only be of attachment nature.","enum":["attachment","signable_document"],"type":"string"},"insert_after_id":{"description":"Insert just after the position of the specified document id","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"password":{"description":"The password required to unlock the document if it is protected","example":"MyPa$$word","type":"string"},"name":{"description":"The new name to be assigned to the document. This value should contain any characters except \"\\\", \"/\" and can\\'t start and finish with a space.","example":"file1","maxLength":128,"minLength":1,"pattern":"^(?!\\s)[^\\/\\\\]+(?<!\\s)$","type":"string"},"initials":{"allOf":[{"$ref":"#/components/schemas/InitialsArea"}],"nullable":true,"type":"object"},"excluded_approvers":{"$ref":"#/components/schemas/DocumentExcludedApprovers"},"excluded_signers":{"$ref":"#/components/schemas/DocumentExcludedSigners"}},"type":"object"},"FieldSignature":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["signature"],"type":"string"},"height":{"format":"int32","maximum":1000,"minimum":37,"type":"integer"},"width":{"format":"int32","maximum":2000,"minimum":85,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"maxLength":150,"nullable":true,"type":"string"},"display":{"$ref":"#/components/schemas/SignatureDisplay"}},"required":["display","document_id","height","id","page","reason","signer_id","type","width","x","y"],"title":"Signature","type":"object"},"FieldText":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["text"],"type":"string"},"width":{"description":"If not set, the width is automatically calculated with the max_length value","example":90,"format":"int32","minimum":24,"type":"integer"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","example":150,"format":"int32","minimum":1,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"question":{"example":"What is your job title?","maxLength":255,"type":"string"},"instruction":{"example":"Your position in the company","nullable":true,"type":"string"},"optional":{"type":"boolean"},"answer":{"example":"Software Engineer","nullable":true,"type":"string"},"max_length":{"maximum":32767,"minimum":1,"type":"integer"},"font":{"$ref":"#/components/schemas/Font"},"name":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"default_value":{"maxLength":32767,"minLength":1,"nullable":true,"type":"string"},"read_only":{"type":"boolean"}},"required":["answer","document_id","font","height","id","instruction","max_length","optional","page","question","signer_id","type","width","x","y"],"title":"Text","type":"object"},"FieldMention":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["mention"],"type":"string"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","format":"int32","minimum":1,"type":"integer"},"width":{"format":"int32","minimum":24,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"mention":{"type":"string"},"font":{"$ref":"#/components/schemas/Font"},"name":{"description":"Name of the Field.","example":"Mention 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["document_id","font","height","id","mention","page","signer_id","type","width","x","y"],"title":"Mention","type":"object"},"FieldCheckbox":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["checkbox"],"type":"string"},"name":{"description":"Checkbox name","example":"Checkbox name","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"checked":{"description":"Signer has checked the checkbox","type":"boolean"},"page":{"format":"int32","minimum":1,"type":"integer"},"optional":{"type":"boolean"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"size":{"description":"The size determines both the width and height of the checkbox.","format":"int32","maximum":240,"minimum":8,"type":"integer"}},"required":["checked","document_id","id","name","optional","page","signer_id","type","x","y"],"title":"Checkbox","type":"object"},"FieldRadioButtonGroup":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["radio_group"],"type":"string"},"page":{"format":"int32","minimum":1,"type":"integer"},"optional":{"description":"Does the Signer has to select one of the radio buttons from this group?","type":"boolean"},"name":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"radios":{"items":{"$ref":"#/components/schemas/FieldRadioButtonGroup_radios_inner"},"type":"array"}},"required":["document_id","id","name","optional","page","radios","signer_id","type"],"title":"RadioGroup","type":"object"},"FieldReadOnlyText":{"properties":{"id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"document_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["read_only_text"],"type":"string"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","example":150,"format":"int32","minimum":1,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the max_length value","example":90,"format":"int32","minimum":24,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"text":{"description":"This property holds the content displayed in the read-only text field.","example":"Please, read the whole document before to sign it.","maxLength":5000,"type":"string"},"font":{"$ref":"#/components/schemas/Font"}},"required":["document_id","font","height","id","page","text","type","width","x","y"],"title":"ReadOnlyText","type":"object"},"FieldSignatureDate":{"properties":{"id":{"example":"94de855c-21c5-4bde-b82c-745ce415b084","format":"uuid","type":"string"},"document_id":{"example":"3218d951-3096-4145-8639-0054757ec223","format":"uuid","type":"string"},"signer_id":{"example":"72cbe6fd-9225-460e-901c-94acf7a066bb","format":"uuid","type":"string"},"type":{"enum":["signature_date"],"type":"string"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","format":"int32","minimum":1,"type":"integer"},"width":{"format":"int32","minimum":24,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"value":{"nullable":true,"type":"string"},"font":{"$ref":"#/components/schemas/Font"},"name":{"description":"Name of the Field.","example":"Date 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"date_format":{"$ref":"#/components/schemas/CreateFieldDateFormat"},"time_format":{"$ref":"#/components/schemas/CreateFieldTimeFormat"},"show_timezone":{"default":false,"description":"Boolean indicating whether to display the timezone abbreviation (e.g., `CEST`) next to the time.","nullable":true,"type":"boolean"},"show_email":{"default":true,"description":"Boolean indicating whether to display the signer's email address.","nullable":false,"type":"boolean"},"offset_unit":{"$ref":"#/components/schemas/CreateFieldOffsetUnit"},"offset_value":{"default":0,"description":"Number of units to add to the signature date. Ignored if `offset_unit` is `null`. For example, use `offset_unit`: `\"month\"` and `offset_value: 3` to display \"signature date + 3 months\"","example":30,"minimum":0,"nullable":true,"type":"integer"}},"required":["document_id","font","height","id","page","signer_id","type","value","width","x","y"],"title":"SignatureDate","type":"object"},"FieldSignerName":{"properties":{"id":{"example":"94de855c-21c5-4bde-b82c-745ce415b084","format":"uuid","type":"string"},"document_id":{"example":"3218d951-3096-4145-8639-0054757ec223","format":"uuid","type":"string"},"signer_id":{"example":"72cbe6fd-9225-460e-901c-94acf7a066bb","format":"uuid","type":"string"},"type":{"enum":["signer_name"],"type":"string"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","format":"int32","minimum":1,"type":"integer"},"width":{"format":"int32","minimum":24,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"value":{"nullable":true,"type":"string"},"font":{"$ref":"#/components/schemas/Font"},"name":{"description":"Name of the Field.","example":"Name 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"name_format":{"$ref":"#/components/schemas/CreateFieldNameFormat"}},"required":["document_id","font","height","id","page","signer_id","type","value","width","x","y"],"title":"SignerName","type":"object"},"FieldSignerEmail":{"properties":{"id":{"example":"94de855c-21c5-4bde-b82c-745ce415b084","format":"uuid","type":"string"},"document_id":{"example":"3218d951-3096-4145-8639-0054757ec223","format":"uuid","type":"string"},"signer_id":{"example":"72cbe6fd-9225-460e-901c-94acf7a066bb","format":"uuid","type":"string"},"type":{"enum":["signer_email"],"type":"string"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","format":"int32","minimum":1,"type":"integer"},"width":{"format":"int32","minimum":24,"type":"integer"},"page":{"format":"int32","minimum":1,"type":"integer"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"value":{"nullable":true,"type":"string"},"font":{"$ref":"#/components/schemas/Font"},"name":{"description":"Name of the Field.","example":"Email 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["document_id","font","height","id","page","signer_id","type","value","width","x","y"],"title":"SignerEmail","type":"object"},"CreateField":{"oneOf":[{"$ref":"#/components/schemas/Signature"},{"$ref":"#/components/schemas/Mention"},{"$ref":"#/components/schemas/SignatureDate"},{"$ref":"#/components/schemas/Text"},{"$ref":"#/components/schemas/Checkbox"},{"$ref":"#/components/schemas/RadioGroup"},{"$ref":"#/components/schemas/ReadOnlyText"},{"$ref":"#/components/schemas/SignerName"},{"$ref":"#/components/schemas/SignerEmail"}],"type":"object"},"UpdateField":{"anyOf":[{"$ref":"#/components/schemas/Signature_1"},{"$ref":"#/components/schemas/Mention_1"},{"$ref":"#/components/schemas/SignatureDate_1"},{"$ref":"#/components/schemas/Text_1"},{"$ref":"#/components/schemas/Checkbox_1"},{"$ref":"#/components/schemas/RadioGroup_1"},{"$ref":"#/components/schemas/ReadOnlyText_1"}],"type":"object"},"FieldAnswer":{"properties":{"value":{"$ref":"#/components/schemas/FieldAnswer_value"}},"required":["value"],"type":"object"},"EmbeddedPreparationLink":{"properties":{"url":{"description":"Short-lived URL opening the Signature Request Embedded Preparation. Expires after 10 minutes.","example":"https://app.yousign.com/embedded-preparation/3ddb8590-87d8-4072-a554-63983af849ef?s=eyJ...&r=abc123&lang=fr&sandbox=false","format":"uri","type":"string"}},"required":["url"],"title":"EmbeddedPreparationLink","type":"object"},"Follower":{"properties":{"email":{"example":"john.doe@example.com","format":"email","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"follower_link":{"format":"uri","minLength":1,"nullable":true,"type":"string"}},"required":["email","follower_link","locale"],"type":"object"},"CreateFollowers":{"description":"A list of Follower objects to be added to the signature request.","items":{"$ref":"#/components/schemas/CreateFollowers_inner"},"type":"array"},"SignatureRequestLabel":{"properties":{"id":{"description":"Unique identifier of the Label.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":false,"readOnly":true,"type":"string"},"name":{"description":"Name of the Label.","example":"Contracts","maxLength":128,"minLength":1,"nullable":false,"type":"string"}},"required":["id","name"],"type":"object"},"Metadata":{"description":"Metadata allows you to attach extra information to your Signature Requests.\\\nThis field must contain JSON data (key / value), with 10 nodes maximum.\\\nEach node key can have 30 characters maximum.\\\nEach node value can contain a string (limited to 255 characters), a boolean, an integer or a float.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and URL.\n","properties":{"data":{"additionalProperties":{"$ref":"#/components/schemas/Metadata_data_value"},"type":"object"}},"title":"Signature Request Metadata","type":"object"},"Signer":{"description":"Signer","properties":{"id":{"format":"uuid","minLength":1,"type":"string"},"info":{"$ref":"#/components/schemas/Signer_info"},"status":{"enum":["initiated","declined","notified","verified","processing","consent_given","signed","aborted","error"],"minLength":1,"type":"string"},"fields":{"items":{"$ref":"#/components/schemas/Signer_fields_inner"},"nullable":true,"type":"array"},"signature_level":{"default":"electronic_signature","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"signature_link":{"format":"uri","minLength":1,"nullable":true,"type":"string"},"signature_link_expiration_date":{"example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"},"signature_image_preview":{"minLength":1,"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/Signer_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/CustomText"},"delivery_mode":{"enum":["email","none"],"nullable":true,"type":"string"},"identification_attestation_id":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"sms_notification":{"$ref":"#/components/schemas/SmsNotification"},"email_notification":{"$ref":"#/components/schemas/EmailNotification"},"pre_identity_verification_required":{"type":"boolean"},"verified_identity_id":{"format":"uuid","minLength":1,"nullable":true,"type":"string"},"recipient_stage_index":{"description":"Position of the recipient in the signing flow. Recipients with the same index are notified simultaneously.","type":"integer"},"excluded_documents":{"description":"List of Document IDs not visible to this Signer.\n","items":{"format":"uuid","type":"string"},"type":"array"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"},"signed_at":{"description":"Timestamp indicating when the Signer completed their signature. Returns null otherwise.","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"}},"required":["custom_text","delivery_mode","disabled_signing_contexts","email_notification","excluded_documents","fields","id","identification_attestation_id","info","pre_identity_verification_required","recipient_stage_index","redirect_urls","signature_authentication_mode","signature_image_preview","signature_level","signature_link","signature_link_expiration_date","signed_at","sms_notification","status","verified_identity_id"],"title":"Signer","type":"object"},"CreateSigner":{"oneOf":[{"$ref":"#/components/schemas/New_Signer_From_Scratch"},{"$ref":"#/components/schemas/New_Signer_From_Existing_User"},{"$ref":"#/components/schemas/New_Signer_From_Existing_Contact"},{"$ref":"#/components/schemas/New_Signer_From_Identity_Verification"}],"type":"object"},"UpdateSigner":{"properties":{"info":{"$ref":"#/components/schemas/UpdateSigner_info"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be a signer. `ordered_signers` must be enabled on the Signature Request.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","nullable":true,"type":"string"},"signature_level":{"default":"electronic_signature","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.\nWhen the Signature Request in `draft` status, updating the authentication mode is available for all Signers, no matter their `signature_level`.\\\nWhen the Signature Request is in `approval` or `ongoing` status, updating the authentication mode is only available for Simple Electronic Signature if Signers have an `initiated` or `notified` status.\n","enum":["otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/New_Signer_From_Scratch_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/New_Signer_From_Scratch_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"},"identification_attestation_id":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"email_notification":{"$ref":"#/components/schemas/EmailNotification_1"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","type":"boolean"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"}},"type":"object"},"SignerAuditTrail":{"example":{"sender":{"id":"3409ab3f-9295-4a69-9923-e9d32d9533d6","type":"User","email":"johnny.wallyday@example.com","last_name":"Wallyday","first_name":"Johnny","ip_address":"172.18.0.1","phone_number":"+447123456789"},"signer":{"id":"44e4b0f8-55c9-48a9-803f-d89957525270","last_name":"Wallyday","first_name":"Johnny","ip_address":"172.18.0.1","phone_number":"+447123456789","email_address":"johnny.wallyday@example.com","consent_given_at":"2021-07-05T12:21:42+00:00","signature_process_completed_at":"2021-07-05T12:21:43+00:00"},"version":5,"documents":[{"id":"a9534a42-bbc1-4355-b270-58f315eda779","name":"sample.pdf","mime_type":"application/pdf","signatures":[{"hash":"4396f6a9f0554928f7bcc8e645a6441cb432c1606137ac8f3a735aef83946974","reason":"Signed by Johnny Wallyday","certificate":{"dn":"CN=Yousign, C=FR, O=Yousign, OU=794513986, serialNumber=2019-02-15 10:07:35:938","oid":"1.2.250.1.302.1.7.1.0","hash":"69570e2d5cc2b352b2249ba32b16195722099a89aa35de71ee1e745f771d66c5","content":"-----BEGIN CERTIFICATE-----\nMIIF8DCCA9igAwIBAgIIdfWiF8OAJo0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBTSUdOMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTkwMjE1MDg1NzM2WhcNMjIwMjE0\nMDkwNzAwWjBnMRAwDgYDVQQDDAdZb3VzaWduMSAwHgYDVQQFExcyMDE5LTAyLTE1\nIDEwOjA3OjM1OjkzODESMBAGA1UECwwJNzk0NTEzOTg2MRAwDgYDVQQKDAdZb3Vz\naWduMQswCQYDVQQGEwJGUjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAIWI+w9xQ9uSt4Lb/l14Yu8yRvCWer06bzm5RFvqgZRiD2Cq2Vx8LNzi0pGCxBdI\nQ9nlWcxCAh67Lp/OygCKpUN2DnNiIiORK5b283VKASlGMy5frVOCKiq2YCz0vA6k\npIqzBP7DKV/CsZ3EqP0uw9C12EH3PrBJGQq4WOZI1Q5Fs2JAhOwfq/wq2orG424y\n0A9+smh8J3DjwSCoMQZrdHd/obK3w8AaTGI535dqWIZ0wKTZBZ7xahGAPGXo9cy9\nUXFtazxWGIcu5uYjRLtlUyialcUgB0db1eyOzFoRJCsaE6s7QgBhQUUfDkXs1UIp\nD0BfB/K2kPxGENm2Uk6WAfcCAwEAAaOCAYYwggGCMAwGA1UdEwEB/wQCMAAwHwYD\nVR0jBBgwFoAUzmRTx3jf2iI16mJGhB48l67NzPUwSwYDVR0gBEQwQjBABgoqgXoB\ngi4BBwEAMDIwMAYIKwYBBQUHAgEWJGh0dHA6Ly95b3VzaWduLmZyL2ZyL3B1Ymxp\nYy9kb2N1bWVudDAgBgNVHSUEGTAXBgorBgEEAYI3CgMMBgkqhkiG9y8BAQUwgbIG\nA1UdHwSBqjCBpzA1oDOgMYYvaHR0cDovL3RtcC55b3VzaWduLmZyL2NybC95b3Vz\naWduc2Fzc2lnbjJjYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAyLnlvdXNpZ24uZnIv\nY3JsL3lvdXNpZ25zYXNzaWduMmNhLmNybDA2oDSgMoYwaHR0cDovL3RtcDMueW91\nc2lnbi5mci9jcmwveW91c2lnbnNhc3NpZ24yY2EuY3JsMB0GA1UdDgQWBBTgXAE8\nONE89UOu8TjrtBH9cbd92jAOBgNVHQ8BAf8EBAMCBkAwDQYJKoZIhvcNAQELBQAD\nggIBAAF+VPpcphjyoU8RvQO14ojWV51wJxsx5ShsvtXPsQ7dBws8XmthuTyyYxtM\nE3dldkJsaQt8vK7/AUURwO7YX7PHVlwIqm2kpNThZ4+sEib3SOivP8vpfIP3mD0+\nIFREI/8adIWYyiYzp1xjuuAoZ6lyg2JsOQ/67nyS+y7sUQ++GfQulb5yjkMytmYs\nPJ0uyjnNAI/+hy4okIY7qgHFZaDGBSqdGU28NZcCEeBLwjcH4ET2Q1LvJ7nkKQMM\ncxw+TXdy7cgIAjdfCymjJ701s43JKI01NFrNZ0I20jTOuh2qB4Kf8fQFwmutTnRM\nP4ZglXsXZkyL9snUWwMSAP9QP13fPD6EDTTshyijvwHb6zbrFg3U7J0m/Sjmqp2A\nzD+pj777dQ2jg0zTJ3WLOosE1/tt60ygK3HhiVnnyM8sdjTrZ6ca9++TgnRthKss\nR35c/1Be3RJtYnar2yn3bA2pklLcjnV8Q3ZSks4ll7XnEI9V8EQSNHkmno7k+asl\nWeQ8eC82fkwCwzXMLBTt1kN+0qXfpvVoSITPSVlOvdCsFCRSC3JMYHUY6c9oUUlV\nCCEBWxe/Vm8R+AG4i3zk9wIoLDLW2eeOx1G61QFtIlgJPbKRLiDZhaGZq1PN8T2o\nD/1S7m9PMISw1hrWHpJM+gZpRLsfRp5EH3ieRFzt24fpIosf\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIGnDCCBISgAwIBAgIIfVpT4jgxW6cwDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyODExWhcNMjYwMTI3\nMTYyODExWjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFNJR04yIFRFU1QgQ0Ex\nEjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV\nBAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBALUsirI2GYG9qu3U2S4V4JI0V9ohNP3W\nEpssSBcepPBV4UPtwAbFGvJqtGO/0nNZO0J7UwUb0sZBnedFl96tRQff3PECyO9k\n1B1/8rK1TbLPQPhTYWlrvX69wHXJFPxf/JkL4l4Lp6nFS80SYlaRj2RHHJ8HDj8S\nP1oULnhW2f2i8AlJwFe34eLJbWgeI5D7UAo59GMQ6bO4aVMaaDWvXsKOn8qmCUwF\ngtQNOqtYyLgURr4qivbjsZEv5H4Ee+wR5J+U6wd9dpIoTV2g1mExNlKVoj9qX9rh\n4al4G80fKNUT8bVnzxmdkDZzuzKm+rNIN6Fnc5CTHu2IcMHcuvKMRvsSJ+0fiz1E\nb/xsKO18Aiy5XOEQFqDrXRKC5AMmF/zB9Fh1Xe7Bi6IQo15NOjOCHLiBTARsMBJ8\nRWTuTv89qnL1lECogFusbptDG4Gu7Y7M13V8gOoGAxBs6uALjoseFZcnLQlIjZCV\nL0xyhrXFCLFnv4gy2+xY1bJNueD3cLFkzaxiCJ4WKesmRIfc6vHaQNl5NpU+9tFb\nU6o01c3fjZUdIh/MR3GFIXNpPsilhl///5aT5h2L98Gmb2q7tqSbFqm5z17MG3uS\ne4zCt+UD7MI8oCF2CELo79xMjtmqEwIf0IU8MxaLaLSZ0J164ZyHwvfIewgBp8XF\nqLn0jrZNiocXAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY\nMBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0\ndHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag\nNKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj\nYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z\nYXNyb290MmNhLmNybDAdBgNVHQ4EFgQUzmRTx3jf2iI16mJGhB48l67NzPUwDgYD\nVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQBZ8ru8LEQ1qzQqG/Rx420f\ncN4YNM1cXV+DwpWOw46Oh9U7BG1i/wYPy6uEZvj/n+nm/MkbajrzTViZnKMRs7Wy\nCWBqvAfl4gcbWvrRzdVwsbd3UbsxD5UD1CkJYl5/4gPvCae6YVCF9WtnH2lSy/Gv\n5bbIfyXF++iNQn+lLe59EhA3WinTql/yk/SPUNVn4/IZ0UWrw1IPS3kmnIal1mk7\npL45n5G51qAHpSbAoTsCeRBJZ6jr38n+FimZahnBZTu4+XycDVicrydpsopQiTt8\nry+mP1b9Nd4eoHR4/F/82w1rNfAM0NJKL8w3qr8lMdxsbANMvW0ixgjRnBpuRRB4\n5iUA5Mb2DbiYJARBoruYqYGya317Gcvtk4w0O48CXR+HPXygHh/63De1JdOUjSc2\nHagr6jp7NKbn/XmWBjWuoG9J9d9sC5U/mgjw5Xjf9jKGuUGz46EtlzzpojVB7fJA\nE2Ye0kOuLANpoTFAI4EJe5nTJz0HsFG3nDshsD9Mb1/kUBSGUDWijL5f0LDqf562\nkTioMpkK7ivZxQksF8+bMId5sUNrDVA/6lhn8tD5gzGacSU7IMfIH3EUKcI1NoWm\nhV+aI8EbXP6251cF74y/tejTUQLdOQ9ut3PsxYmTTDqr8RPI6UZeh2yibzSmgGwU\nfylsTiF/gVGm5cpWCrULCw==\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIGnDCCBISgAwIBAgIIT0TY3eM9ut0wDQYJKoZIhvcNAQELBQAwfzEkMCIGA1UE\nAwwbWU9VU0lHTiBTQVMgLSBST09UMiBURVNUIENBMRIwEAYDVQQLDAk3OTQ1MTM5\nODYxFDASBgNVBAoMC1lPVVNJR04gU0FTMQ0wCwYDVQQHDARDQUVOMREwDwYDVQQI\nDAhDQUxWQURPUzELMAkGA1UEBhMCRlIwHhcNMTYwMTI3MTYyNjE2WhcNMzYwMTI3\nMTYyNjE2WjB/MSQwIgYDVQQDDBtZT1VTSUdOIFNBUyAtIFJPT1QyIFRFU1QgQ0Ex\nEjAQBgNVBAsMCTc5NDUxMzk4NjEUMBIGA1UECgwLWU9VU0lHTiBTQVMxDTALBgNV\nBAcMBENBRU4xETAPBgNVBAgMCENBTFZBRE9TMQswCQYDVQQGEwJGUjCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBALXMHUFwSacaI5TjtMRw4kJ9o1ve/IZo\noj+2HOpW3iqs74cmsYjpHbJD0UAdh3SpdlLFK1/WBf0uEbzn6z7gRfUkEAo5EnHs\nM1iTfCXWDtA+xd9X4h2UAVEdXRzglvOvT275fjI1uj9Zi4Rz95drhlGkZVCDIMuv\n7fazkT868grWSfGSUc2C8d9+kOL4pCKuSanOc/nwD61F+oQ6KeEMtmpbr57Yy+qY\ntaF6ieKiDGn0aDj3yImnA9YqfFlX4mCyn+LmiqrXyEn0Z5iYLbO0wXkyPqhcO9c9\ngS1Y8Y/1AEvxnaLlV3eG402ZYUS6tT27o+tpdCAIx+3zMhNsPI9wXUjlVr/8ts+/\nuOUUCUWoBK3J6R1zG3urCdnuor8xAaWK/OHtvg8rXoXEfi8ujWV3EbiwIwiUHVh4\nrJIE1vhsVPW/sTM9yEjRFks0swyoX6QupEuaZLV4DbmcEbmZ2XIH5Cw2c1qwUTk2\n8vQzKHszLdRb9scnjd3yHsef5ZAHS9hUoFIfG+MzINGm3U6v4exspSw/EshSavVj\nR+gL0l+sdK4L6xe++K++Gpp5xn5cZUJeg4YtdgGju7lMdGpJVVwl0Y8UAEJt9xgC\nMvGctrkoaUuBjOhrGQQITDMsNrtgi28s7rUB6k+yxcaGBBp2PyAIsIe0e1wKGm1N\nHjGtqY0IV1tFAgMBAAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQY\nMBaAFGXEFaTuRlW+zr11R8A0QEYcGvuRMIGyBgNVHR8EgaowgacwNaAzoDGGL2h0\ndHA6Ly90bXAueW91c2lnbi5mci9jcmwveW91c2lnbnNhc3Jvb3QyY2EuY3JsMDag\nNKAyhjBodHRwOi8vdG1wMi55b3VzaWduLmZyL2NybC95b3VzaWduc2Fzcm9vdDJj\nYS5jcmwwNqA0oDKGMGh0dHA6Ly90bXAzLnlvdXNpZ24uZnIvY3JsL3lvdXNpZ25z\nYXNyb290MmNhLmNybDAdBgNVHQ4EFgQUZcQVpO5GVb7OvXVHwDRARhwa+5EwDgYD\nVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQCuxOXQDSYF0RpYQWonRDlU\nZ64IaGJ5buU4tGzf7rAgIQdXbO/VjjfF9UsjnLopNwWkuSJvINm21obYHcoSwvpz\nlwS/3uJCLxaw5q4SVJ4x5rajh/2qtFzcThSh48rcXcqoxAmc6BzQuIOm9cFUD2Ri\nqUJmg5O+CoLuE1b4i+CsCFL3AoWnBHFZ4YtInQBFIRBhMNPICvYOCF6jjgmMxkWU\nM8SEp7FSFfsy/oPI1dt+k9JjHCXhtWO9ndLvvwvLcjqRO3ItiF9IazsNcNLhaIMA\nlvYiQ+jLpckAuTxj7XHQyJSEofTMPr+ZSgQwUc337MJyxPhTDkch5cQBfnC20Usk\nyjdwwaeiwnNMhESwgDa4Oqw5IOmq+VmqtR+9F9yxACrpyph593F1zYwv7ikik5dI\nIYACb2fKLQrcnCfhm0k1Nt9UXoc9mQzFUK0DWJNLeGJo0rfRQh5ZqhcBG2U0KZFQ\nRtQQEf3zXJxQJGlCn1UMZMJswAzfhMTdGPNzyDI2u+9Q8WT7M2f59Idiae2m79uG\nuStRwN7Vnrpa399YXixOpNTz6d0NFBOAq1Nfwy5cnQDCnT9JkrKidrFKyA21b67m\nSfJIpMSPfFbt3g0h7JPWK7OC4Ydydh92e7/IUhtkudKMoazlwSJ7484dE7NyTpol\n62H0sW/1gmFzE6/QmCUR+w==\n-----END CERTIFICATE-----","generated_at":"2019-02-15T09:07:36+00:00"}}],"initial_hash":"8decc8571946d4cd70a024949e033a2a2a54377fe9f1c1b944c20f9ee11a9e51","initial_storage_id":"fdad7bcf-73d5-4a73-945d-ba7b738c530b"}],"organization":{"id":"d89a0f7b-bd3f-494d-ab61-71b69f24a3d9","name":"Universalt Music"},"authentication":{"mode":"sms","message":"eSIGNATURE: 791994 is your security code to confirm the signature of your documents.","validated_at":"2021-07-05T12:21:40+00:00"},"signature_request":{"id":"4d164217-60e7-4733-b56c-65ad637eadce","name":"My new request","sent_at":"2021-07-05T12:21:21+00:00","expired_at":"2022-01-05T22:59:00+00:00"},"electronic_signature_level":{"level":"Simple electronic signature"}},"properties":{"version":{"type":"number"},"signature_request":{"type":"object"},"sender":{"type":"object"},"signer":{"type":"object"},"documents":{"items":{"type":"object"},"minItems":1,"type":"array","uniqueItems":true},"organization":{"type":"object"},"authentication":{"type":"object"},"electronic_signature_level":{"type":"object"}},"required":["authentication","documents","organization","sender","signature_request","signer","version"],"type":"object"},"SignerDocument":{"description":"Signer Document","properties":{"id":{"description":"Unique identifier of the signer document","example":"69df8404-40d3-4686-887b-5678f46a0d9a","format":"uuid","type":"string"},"title":{"description":"Title of the document request","example":"Proof of address","maxLength":255,"minLength":1,"type":"string"},"filename":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["filename","id","title"],"type":"object"},"SignerIdentityVerification":{"additionalProperties":false,"properties":{"type":{"description":"Type of document you are looking to verify. Only passports, id and resident permits are accepted.","enum":["id_card","passport","residence_permit"],"example":"id_card","type":"string"},"recto":{"description":"Front of the identity document file to verify.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"verso":{"description":"Back of the identity document file to verify.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"}},"required":["recto","type"],"type":"object"},"SignerSign":{"properties":{"otp":{"example":"231457","nullable":true,"pattern":"^[0-9]{6}$","title":"One-Time Password (OTP) sent to the Signer","type":"string"},"ip_address":{"$ref":"#/components/schemas/Signer_s_IP_address"},"consent_given_at":{"description":"UTC date. Must be in format `2024-01-18T22:00:00+00:00`","example":"2024-01-18T22:00:00Z","format":"date-time","title":"Signer's consent date","type":"string"}},"required":["consent_given_at","ip_address"],"type":"object"},"SignerSignWithUploadedSignatureImage":{"properties":{"otp":{"example":"231457","nullable":true,"pattern":"^[0-9]{6}$","title":"One-Time Password (OTP) sent to the Signer","type":"string"},"ip_address":{"$ref":"#/components/schemas/Signer_s_IP_address"},"consent_given_at":{"description":"UTC date. Must be in format `2024-01-18T22:00:00+00:00`","example":"2024-01-18T22:00:00Z","format":"date-time","title":"Signer's consent date","type":"string"},"signature_image":{"description":"Signature image of the Signer to be displayed on the signed Document.","format":"binary","title":"Image to use as signature","type":"string"}},"required":["consent_given_at","ip_address","signature_image"],"type":"object"},"Template":{"properties":{"id":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"description":{"nullable":true,"readOnly":true,"type":"string"},"status":{"enum":["draft","active"],"readOnly":true,"type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"},"workspace_id":{"example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"required":["created_at","description","id","name","status"],"title":"Template","type":"object"},"User":{"properties":{"id":{"example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"first_name":{"example":"John","nullable":true,"type":"string"},"last_name":{"example":"Doe","nullable":true,"type":"string"},"email":{"example":"email@example.com","format":"email","type":"string"},"phone_number":{"description":"E.164 format","example":"+447123456789","nullable":true,"type":"string"},"locale":{"example":"en","type":"string"},"avatar":{"example":"https://example.com/users/123456/avatar","nullable":true,"type":"string"},"job_title":{"example":"Worker","nullable":true,"type":"string"},"is_active":{"type":"boolean"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"},"role":{"$ref":"#/components/schemas/UserRole"},"workspaces":{"items":{"$ref":"#/components/schemas/User_workspaces_inner"},"type":"array"},"status":{"$ref":"#/components/schemas/UserStatus"},"source":{"description":"The application used to create the `User`","enum":["app","public_api"],"example":"public_api","nullable":false,"type":"string"}},"required":["avatar","created_at","email","first_name","id","is_active","job_title","last_name","locale","phone_number","role","source","status","workspaces"],"title":"User","type":"object"},"CreateUser":{"properties":{"email":{"description":"The email address must not match any existing User's email.\n","example":"john.doe@example.com","format":"email","title":"User's email address","type":"string"},"role":{"description":"Role assigned to the User in the Organization.\n","enum":["admin","member"],"title":"User's role","type":"string"},"locale":{"$ref":"#/components/schemas/Locale"},"workspaces":{"description":"The new User must be associated with at least one Workspace in the Organization.\n","items":{"$ref":"#/components/schemas/UUID"},"minItems":1,"title":"User's Workspace","type":"array","uniqueItems":true},"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"User's first name","example":"John","maxLength":255,"minLength":1,"nullable":true,"title":"First name","type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"User's last name","example":"Doe","maxLength":255,"minLength":1,"nullable":true,"title":"Last name","type":"string"},"phone_number":{"description":"E.164 format","example":"+41446667700","minLength":1,"nullable":true,"title":"User's phone number","type":"string"},"job_title":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Employee","format":"safe-string","maxLength":255,"minLength":1,"nullable":true,"title":"User's job title","type":"string"}},"required":["email","locale","role","workspaces"],"title":"A User object","type":"object"},"UserInvitation":{"properties":{"id":{"example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","readOnly":true,"type":"string"},"email":{"example":"email@example.com","format":"email","readOnly":true,"type":"string"},"role":{"$ref":"#/components/schemas/ManageableRole"},"workspaces":{"items":{"$ref":"#/components/schemas/User_workspaces_inner"},"readOnly":true,"type":"array"},"expired_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"}},"required":["created_at","email","expired_at","id","role","workspaces"],"title":"Invitation","type":"object"},"UpdateUser":{"properties":{"role":{"description":"New role assigned to the User. It can be `member` or `admin`.","enum":["admin","member"],"type":"string"},"active":{"description":"If `true`, the User will be activated; if `false`, the User will be suspended.","type":"boolean"}},"type":"object"},"BankAccountLookupMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Bank Account Lookup Verification.","example":"2025-07-23T18:22:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Bank Account Lookup Verification.","example":"2025-07-23T18:22:00Z","format":"date-time","type":"string"},"status":{"description":"Status of the Bank Account Lookup Verification.","enum":["pending","awaiting_data","verified","failed","inconclusive"],"example":"verified","type":"string"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["BALV_1101"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the Bank Account Lookup Verification data has been anonymized.\nIf set to `true`, all fields in the `data` field are set to NULL.\n","example":false,"nullable":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["created_at","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"BankAccountLookupMeta","type":"object"},"InitiateBankAccountLookupWithNaturalPerson":{"additionalProperties":false,"properties":{"iban":{"description":"The International Bank Account Number (IBAN) to verify.\nThe IBAN must be a valid IBAN from a supported country: AT, BE, HR, CY, EE, FI, FR, DE, GR, IE, IT, LV, LT, LU, MT, NL, PT, SK, SI, ES.\n","example":"FR7630006000011234567890189","type":"string"},"natural_person":{"$ref":"#/components/schemas/InitiateBankAccountLookupWithNaturalPerson_natural_person"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["iban","natural_person"],"title":"Initiate a new Bank Account Lookup Verification with natural person","type":"object"},"InitiateBankAccountLookupFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["applicant_id"],"title":"Attach a new Bank Account Lookup Verification to an Applicant","type":"object"},"InitiateBankAccountLookupWithNaturalPersonFromFile":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the IBAN number.\nAccepted formats: PDF.\nMax size: 10 MB.\n","example":"Binary file","format":"binary","type":"string"},"natural_person":{"$ref":"#/components/schemas/InitiateBankAccountLookupWithNaturalPerson_natural_person"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["file","natural_person"],"title":"Initiate a new Bank Account Lookup Verification with natural person","type":"object"},"BankAccountLookupFull":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"created_at":{"description":"Creation date of the Bank Account Lookup Verification.","example":"2025-07-23T18:22:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Bank Account Lookup Verification.","example":"2025-07-23T18:22:00Z","format":"date-time","type":"string"},"status":{"description":"Status of the Bank Account Lookup Verification.","enum":["pending","verified","failed","inconclusive"],"example":"verified","type":"string"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["BALV_1101"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the Bank Account Lookup Verification data has been anonymized.\nIf set to `true`, all fields in the `data` field are set to NULL.\n","example":false,"nullable":false,"type":"boolean"},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"},"data":{"$ref":"#/components/schemas/BankAccountLookupFull_data"}},"required":["applicant_id","created_at","data","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"BankAccountLookupFull","type":"object"},"BankAccountMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Bank Account Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Bank Account Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/BankAccountStatus"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["BAV_1604","BAV_1611"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the personal data extracted from the document has been anonymized.\nIf set to `true`, the personal data has been anonymized and most fields will be NULL.\n","type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"}},"required":["applicant_id","created_at","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id"],"title":"BankAccountMeta","type":"object"},"InitiateBankAccountFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["applicant_id"],"title":"Attach a new Bank Account Verification to an Applicant","type":"object"},"InitiateBankAccount":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the bank account details.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"iban":{"$ref":"#/components/schemas/IBAN"},"bic":{"$ref":"#/components/schemas/BIC"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["file"],"title":"Initiate Bank Account Verification","type":"object"},"InitiateBankAccountWithLegalPerson":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the bank account details.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"iban":{"$ref":"#/components/schemas/IBAN"},"bic":{"$ref":"#/components/schemas/BIC"},"legal_person":{"$ref":"#/components/schemas/InitiateBankAccountWithLegalPerson_legal_person"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["file","legal_person"],"title":"Initiate Bank Account Verification with legal person","type":"object"},"InitiateBankAccountWithNaturalPerson":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the bank account details.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"iban":{"$ref":"#/components/schemas/IBAN"},"bic":{"$ref":"#/components/schemas/BIC"},"natural_person":{"$ref":"#/components/schemas/InitiateBankAccountWithNaturalPerson_natural_person"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["file","natural_person"],"title":"Initiate Bank Account Verification with natural person","type":"object"},"BankAccountFull":{"allOf":[{"$ref":"#/components/schemas/BankAccountMeta"},{"properties":{"data":{"$ref":"#/components/schemas/BankAccountFull_allOf_data"}},"required":["data"],"type":"object"}],"title":"BankAccountFull","type":"object"},"CompanyMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Company Verification.","example":"2023-01-01T12:00:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Company Verification.","example":"2023-01-01T12:00:00Z","format":"date-time","type":"string"},"status":{"description":"Status of the Company Verification.","enum":["pending","awaiting_data","verified","failed","inconclusive"],"example":"verified","type":"string"},"data_anonymized":{"description":"Indicates if the company data has been anonymized.\nIf set to `true`, all fields in the `data` field are set to NULL.\n","example":false,"nullable":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"}},"required":["applicant_id","created_at","id","previous_attempt_id","status","updated_at","workflow_session_id","workspace_id"],"title":"CompanyMeta","type":"object"},"InitiateCompanyFromJson":{"properties":{"company_number":{"description":"Please provide the exact company number depending on the country format.\nFor any doubt, consult the Company Verification [guide](https://developers.youtrust.com/docs/company-verification).\n","example":"794513986","minLength":1,"type":"string"},"country_code":{"description":"Defines the country where the company is registered.","enum":["FR","GB","BE","CH","NL","ES","LU","IT","DE"],"example":"FR","maxLength":2,"minLength":2,"type":"string"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"company_name":{"description":"The company name. Required for German (DE) companies.\\\nWhen country_code is DE, this field must be provided.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Test Company GmbH","format":"safe-string","maxLength":255,"nullable":true,"type":"string"},"zip_code":{"description":"Additional search field. Only accepted when country_code is DE.\\\nFor DE, it must be a 5-digit Postleitzahl (e.g. \"10115\").\\\nHelps narrow the company lookup when several companies share similar names.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"10115","format":"safe-string","maxLength":10,"nullable":true,"type":"string"},"street":{"description":"Additional search field. Only accepted when country_code is DE.\\\nHelps narrow the company lookup when several companies share similar names.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Unter den Linden 1","format":"safe-string","maxLength":255,"nullable":true,"type":"string"},"city":{"description":"Additional search field. Only accepted when country_code is DE.\\\nHelps narrow the company lookup when several companies share similar names.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Berlin","format":"safe-string","maxLength":255,"nullable":true,"type":"string"},"register_court":{"description":"Additional search field. Only accepted when country_code is DE.\\\nThe German commercial register court (Registergericht) handling the company.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Amtsgericht Berlin (Charlottenburg)","format":"safe-string","maxLength":255,"nullable":true,"type":"string"}},"required":["company_number","country_code"],"title":"Initiate Company Verification from company number","type":"object"},"InitiateCompanyFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["applicant_id"],"title":"Attach a new Company Verification to an Applicant","type":"object"},"InitiateCompanyFromFile":{"properties":{"file":{"description":"The file containing the company details mostly known as Kbis.\nAccepted formats: PDF.\nMax size: 10 MB.\n","example":"Binary file","format":"binary","type":"string"},"country_code":{"enum":["FR"],"example":"FR","maxLength":2,"minLength":2,"type":"string"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["country_code","file"],"title":"Initiate Company Verification from Kbis","type":"object"},"CompanyFull":{"allOf":[{"$ref":"#/components/schemas/CompanyMeta"},{"properties":{"data":{"$ref":"#/components/schemas/CompanyFull_allOf_data"}},"required":["data"],"type":"object"}],"title":"CompanyFull","type":"object"},"IdentityDocumentMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Identity Document Verification.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Identity Document Verification.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/IdentityDocumentStatus"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["IDDV_1706","IDDV_1707"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the personal data extracted from the document has been anonymized.\nIf set to `true`, the personal data has been anonymized and most fields will be NULL.\n","example":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"}},"required":["applicant_id","created_at","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"IdentityDocumentMeta","type":"object"},"InitiateIdentityDocumentFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["applicant_id"],"title":"Attach a new Identity Document Verification to an Applicant","type":"object"},"InitiateIdentityDocument":{"additionalProperties":false,"properties":{"first_name":{"description":"Please provide the holder first name, exactly as it appears on the ID document.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\n","example":"John","maxLength":255,"minLength":1,"nullable":false,"type":"string"},"last_name":{"description":"Please provide the holder last name, exactly as it appears on the ID document birth name.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\n","example":"Doe","maxLength":255,"minLength":1,"nullable":false,"type":"string"},"type":{"description":"The document type to verify","enum":["id_card","passport","residence_permit","ita_ts_cns"],"example":"id_card","type":"string"},"file":{"description":"The identity document file to verify.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"additional_file":{"description":"Additional document file, such as the back side of an identity card.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"min_age":{"description":"Minimum age required for the document holder.","example":18,"minimum":1,"nullable":true,"type":"integer"},"max_age":{"description":"Maximum age allowed for the document holder.","example":65,"minimum":1,"nullable":true,"type":"integer"},"prohibited_countries":{"description":"List of prohibited issuing countries (ISO 3166-1 alpha-2).","example":["RU","KP"],"items":{"pattern":"^[A-Z]{2}$","type":"string"},"minItems":1,"nullable":true,"type":"array"}},"required":["file","first_name","last_name"],"title":"Initiate an Identity Document Verification with names","type":"object"},"InitiateIdentityDocumentWithoutName":{"additionalProperties":false,"properties":{"type":{"description":"The document type to verify","enum":["id_card","passport","residence_permit","ita_ts_cns"],"example":"id_card","type":"string"},"file":{"description":"The identity document file to verify.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"additional_file":{"description":"Additional document file, such as the back side of an identity card.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"min_age":{"description":"Minimum age required for the document holder.","example":18,"minimum":1,"nullable":true,"type":"integer"},"max_age":{"description":"Maximum age allowed for the document holder.","example":65,"minimum":1,"nullable":true,"type":"integer"},"prohibited_countries":{"description":"List of prohibited issuing countries (ISO 3166-1 alpha-2).","example":["RU","KP"],"items":{"pattern":"^[A-Z]{2}$","type":"string"},"minItems":1,"nullable":true,"type":"array"}},"required":["file"],"title":"Initiate an Identity Document Verification without names","type":"object"},"IdentityDocumentFull":{"allOf":[{"$ref":"#/components/schemas/IdentityDocumentMeta"},{"properties":{"data":{"$ref":"#/components/schemas/IdentityDocumentFull_allOf_data"}},"required":["data"],"type":"object"}],"title":"IdentityDocumentFull","type":"object"},"IdentityVideoMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Identity Video Verification.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Identity Video Verification.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/IdentityVideoStatus"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["IDVV_1112"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the personal data extracted has been anonymized.\nIf set to `true`, the personal data has been anonymized and most fields will be NULL.\n","example":false,"type":"boolean"},"face_recognition":{"description":"Indicates if face recognition was enabled during the verification process.","example":false,"type":"boolean"},"pvid":{"description":"Indicates if PVID was enabled during the verification process.","example":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["created_at","data_anonymized","face_recognition","id","previous_attempt_id","pvid","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"IdentityVideoMeta","type":"object"},"InitiateIdentityVideo":{"additionalProperties":false,"properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"The first name provided must match exactly as it appears on the ID document, as a consistency check will be performed. If multiple given names are listed on the document, you must provide only one of them.","example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"The last name provided must match exactly as it appears on the ID document, as a consistency check will be performed. If both a birth name and a usage name are listed on the document, you must provide one of them, but not both.","example":"Doe","maxLength":255,"minLength":1,"type":"string"},"redirection_url":{"description":"The URL to redirect the person back to your application or website after the identity verification flow is complete.","example":"https://example.com/","format":"uri","maxLength":2000,"minLength":1,"type":"string"},"face_recognition":{"default":false,"description":"Enable face recognition step in the identity verification flow.","example":false,"type":"boolean"},"pvid":{"default":false,"description":"Enable PVID mode in the identity verification flow.","example":false,"type":"boolean"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"min_age":{"description":"Minimum age required for the document holder.","example":18,"minimum":1,"nullable":true,"type":"integer"},"max_age":{"description":"Maximum age allowed for the document holder.","example":65,"minimum":1,"nullable":true,"type":"integer"},"prohibited_countries":{"description":"List of prohibited issuing countries (ISO 3166-1 alpha-2).","example":["RU","KP"],"items":{"pattern":"^[A-Z]{2}$","type":"string"},"minItems":1,"nullable":true,"type":"array"},"pre_selected_residence_country_code":{"description":"Pre-fill the residence country in the verification flow (ISO 3166-1 alpha-2, uppercase).","example":"FR","format":"ISO 3166-1 alpha-2","nullable":true,"pattern":"^[A-Z]{2}$","type":"string"},"pre_selected_document_issuing_country_code":{"description":"Pre-fill the document issuing country in the verification flow (ISO 3166-1 alpha-2, uppercase).","example":"FR","format":"ISO 3166-1 alpha-2","nullable":true,"pattern":"^[A-Z]{2}$","type":"string"},"pre_selected_document_type":{"description":"Pre-fill the document type in the verification flow.","enum":["id_card","passport","residence_permit","driver_license","travel_document"],"example":"id_card","nullable":true,"type":"string"},"pre_selected_locale":{"description":"Pre-fill the UI language of the verification flow (ISO 639-1, lowercase 2-letter code).","example":"fr","format":"ISO 639-1","nullable":true,"pattern":"^[a-z]{2}$","type":"string"}},"required":["first_name","last_name","redirection_url"],"title":"Initiate Identity Video Verification","type":"object"},"IdentityVideoFull":{"allOf":[{"$ref":"#/components/schemas/IdentityVideoMeta"},{"properties":{"verification_url":{"description":"The URL of the verification page that the user used to begin the verification process.","example":"https://id.ubble.ai/2f3e833c-6cf8-4c39-9004-cfb0e048ef63","format":"uri","minLength":1,"nullable":true,"type":"string"},"data":{"$ref":"#/components/schemas/IdentityVideoFull_allOf_data"}},"required":["data","verification_url"],"type":"object"}],"title":"IdentityVideoFull","type":"object"},"ProofOfAddressMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the Proof of Address Verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Proof of Address Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Proof of Address Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"status":{"description":"Status of the verification","enum":["pending","awaiting_data","verified","failed","inconclusive"],"example":"failed","type":"string"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed` or `inconclusive`.","example":["POAV_1611","POAV_1612"],"items":{"type":"string"},"type":"array"},"data_anonymized":{"description":"Indicates if the data related to the ProofOfAddress Verification has been anonymized.\nIf set to `true`, the data are removed and most fields will be NULL.\n","example":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"}},"required":["applicant_id","created_at","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"ProofOfAddressMeta","type":"object"},"InitiateProofOfAddressFromApplicant":{"additionalProperties":false,"properties":{"applicant_id":{"description":"The Applicant ID linked to the Workflow Session.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["applicant_id"],"title":"Attach a new Proof of Address Verification to an Applicant","type":"object"},"InitiateProofOfAddress":{"additionalProperties":false,"properties":{"file":{"description":"The proof of address document.\nAccepted formats: PNG, JPEG, JPG, PDF.\nMax size: 10 MB. Max resolution: 20 mpx.\n","format":"binary","type":"string"},"natural_person":{"$ref":"#/components/schemas/InitiateProofOfAddress_natural_person"},"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["file"],"title":"Create Proof of Address Verification","type":"object"},"ProofOfAddressVerificationFull":{"allOf":[{"$ref":"#/components/schemas/ProofOfAddressMeta"},{"properties":{"data":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull_allOf_data"}},"required":["data"],"type":"object"}],"title":"ProofOfAddressVerificationFull","type":"object"},"WatchlistMeta":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the verification has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Watchlist Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Watchlist Verification.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/WatchlistStatus"},"data_anonymized":{"description":"Indicates if the data related to the Watchlist Verification has been anonymized.\nIf set to `true`, the data are removed and most fields will be NULL.\n","example":false,"type":"boolean"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["created_at","data_anonymized","id","previous_attempt_id","status","updated_at","workflow_session_id","workspace_id"],"title":"WatchlistMeta","type":"object"},"InitiateWatchlist":{"additionalProperties":false,"properties":{"workspace_id":{"description":"Scopes the verification to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde3","format":"uuid","nullable":true,"type":"string"},"natural_person":{"$ref":"#/components/schemas/InitiateWatchlist_natural_person"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["natural_person"],"title":"Initiate Watchlist Verification","type":"object"},"WatchlistFull":{"allOf":[{"$ref":"#/components/schemas/WatchlistMeta"},{"properties":{"data":{"$ref":"#/components/schemas/WatchlistFull_allOf_data"}},"required":["data"],"type":"object"}],"title":"WatchlistFull","type":"object"},"WebhookSubscription":{"properties":{"id":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","type":"string"},"endpoint":{"description":"HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.","example":"https://example.com:port/my-endpoint","format":"uri","maxLength":1024,"type":"string"},"description":{"description":"Short description of the webhook","example":"Lorem Ipsum","maxLength":128,"nullable":true,"type":"string"},"sandbox":{"example":false,"type":"boolean"},"subscribed_events":{"$ref":"#/components/schemas/WebhookSubscription_subscribed_events"},"secret_key":{"description":"Autogenerated 32 bytes key","type":"string"},"scopes":{"$ref":"#/components/schemas/WebhookSubscription_scopes"},"workspaces":{"$ref":"#/components/schemas/WebhookSubscription_workspaces"},"auto_retry":{"description":"If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min","type":"boolean"},"enabled":{"description":"Is the webhook enabled?","type":"boolean"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"}},"required":["auto_retry","created_at","description","enabled","endpoint","id","sandbox","scopes","secret_key","subscribed_events","updated_at","workspaces"],"title":"WebhookSubscription Response","type":"object"},"CreateWebhookSubscription":{"properties":{"endpoint":{"description":"HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.","example":"https://example.com:port/my-endpoint","format":"uri","maxLength":1024,"type":"string"},"description":{"description":"Short description of the webhook.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Lorem Ipsum","format":"safe-string","maxLength":128,"nullable":true,"type":"string"},"sandbox":{"example":true,"type":"boolean"},"subscribed_events":{"$ref":"#/components/schemas/CreateWebhookSubscription_subscribed_events"},"secret_key":{"description":"Autogenerated 32 bytes key","maxLength":32,"minLength":32,"nullable":true,"type":"string"},"scopes":{"$ref":"#/components/schemas/CreateWebhookSubscription_scopes"},"workspaces":{"$ref":"#/components/schemas/CreateWebhookSubscription_workspaces"},"auto_retry":{"description":"If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min","type":"boolean"},"enabled":{"description":"Choose whether the webhook is enabled or not.","type":"boolean"}},"required":["auto_retry","description","enabled","endpoint","sandbox","scopes","subscribed_events"],"title":"CreateWebhookSubscription Request Body","type":"object"},"UpdateWebhookSubscription":{"properties":{"endpoint":{"description":"HTTPS target URL that will receive webhook POST requests. It must be publicly accessible and may include a specified port.","example":"https://example.com:port/my-endpoint","format":"uri","maxLength":1024,"type":"string"},"description":{"description":"Short description of the webhook.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Lorem Ipsum","format":"safe-string","maxLength":128,"nullable":true,"type":"string"},"sandbox":{"example":true,"type":"boolean"},"subscribed_events":{"$ref":"#/components/schemas/CreateWebhookSubscription_subscribed_events"},"secret_key":{"description":"Autogenerated 32 bytes key","maxLength":32,"minLength":32,"nullable":true,"type":"string"},"scopes":{"$ref":"#/components/schemas/CreateWebhookSubscription_scopes"},"workspaces":{"$ref":"#/components/schemas/CreateWebhookSubscription_workspaces"},"auto_retry":{"description":"If a Webhook request fails for any reason, Youtrust will retry the request 8 times using a back-off mechanism after: 2, 6, 30, 60, 300, 1080, 1440, 2880 min","type":"boolean"},"enabled":{"description":"Choose whether the webhook is enabled or not.","type":"boolean"}},"title":"UpdateWebhookSubscription Request Body","type":"object"},"WorkflowSession":{"additionalProperties":false,"properties":{"id":{"description":"Unique identifier of the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"name":{"description":"Name given to the Workflow Session. Used to easily find it in the application.","example":"Customer onboarding of John Doe","type":"string"},"workflow_template_id":{"description":"Unique identifier of the Workflow Template from which this Workflow Session was created.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"workspace_id":{"description":"Unique identifier of the Workspace in which this Workflow Session is scoped.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"status":{"description":"Status of the Workflow Session.","enum":["awaiting","ongoing","blocked","done"],"example":"ongoing","type":"string"},"action_groups":{"description":"List of the Action Groups contained in the Workflow Session.","items":{"$ref":"#/components/schemas/WorkflowSession_action_groups_inner"},"type":"array"}},"required":["action_groups","created_at","id","name","status","updated_at","workflow_template_id","workspace_id"],"title":"Workflow Session","type":"object"},"CreateWorkflowSession":{"additionalProperties":false,"properties":{"workflow_template_id":{"description":"Unique ID of the Workflow Template from which to create the new Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"workspace_id":{"description":"Unique ID of the Workspace in which to scope the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"name":{"description":"Name given to the Workflow Session. Enter a meaningful, descriptive name to help you easily find this Workflow Session in the application.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Customer onboarding of John Doe.","format":"safe-string","maxLength":128,"minLength":1,"type":"string"}},"required":["name","workflow_template_id"],"type":"object"},"WorkflowSessionApplicantListItem":{"additionalProperties":false,"description":"An Applicant associated with a Workflow Session (list view).","properties":{"id":{"description":"Unique identifier of the Applicant.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"description":"Unique identifier of the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"status":{"description":"Status of the Applicant.","enum":["initiated","notified","processed"],"example":"initiated","type":"string"},"label":{"description":"Label of the Applicant.","example":"John Doe","type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"created_at":{"description":"Creation date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Last update date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"type":{"description":"Type of the Applicant.","enum":["natural_person","legal_person"],"example":"natural_person","type":"string"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session), or null for a root / standalone Applicant.","format":"uuid","nullable":true,"type":"string","example":null},"child_applicant_ids":{"description":"The ids of the child Applicants; empty for a natural_person or a childless root.","example":[],"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["child_applicant_ids","created_at","delivery_mode","email","id","label","parent_applicant_id","reference_id","status","type","updated_at","workflow_session_id"],"title":"Applicant List Item","type":"object"},"CreateWorkflowSessionApplicant":{"description":"Request body to create a new Applicant for a Workflow Session.","discriminator":{"mapping":{"natural_person":"#/components/schemas/CreateWorkflowSessionApplicantNaturalPerson","legal_person":"#/components/schemas/CreateWorkflowSessionApplicantLegalPerson"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/CreateWorkflowSessionApplicantNaturalPerson"},{"$ref":"#/components/schemas/CreateWorkflowSessionApplicantLegalPerson"}],"title":"Create Applicant"},"WorkflowSessionApplicant":{"description":"An Applicant associated with a Workflow Session (full view).","discriminator":{"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/Natural_Person_Applicant"},{"$ref":"#/components/schemas/Legal_Person_Applicant"}],"title":"Applicant"},"UpdateWorkflowSessionApplicant":{"additionalProperties":false,"description":"Update an Applicant associated with a Workflow Session (PATCH).","properties":{"label":{"description":"Label of the Applicant.","example":"John Doe","maxLength":255,"minLength":1,"type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"natural_person":{"$ref":"#/components/schemas/UpdateNaturalPerson"},"legal_person":{"$ref":"#/components/schemas/UpdateLegalPerson"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session). Can be changed until the first magic link has been generated for the Workflow Session; once a link exists the parent is immutable and any attempt to change it returns a 400 error.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"title":"Update Applicant","type":"object"},"WorkflowSessionLinks":{"additionalProperties":false,"description":"Portal links for Workflow Session Applicants. A root Applicant's entry covers its child Applicants, which are not returned as separate entries.","properties":{"applicants":{"description":"List of Applicants with their portal links. A root Applicant's entry covers its child Applicants, so child Applicants are not returned as separate entries.","items":{"$ref":"#/components/schemas/WorkflowSessionLinks_applicants_inner"},"type":"array"}},"required":["applicants"],"title":"Workflow Session Links","type":"object"},"ResolveWorkflowSessionAction":{"additionalProperties":false,"properties":{"resource":{"$ref":"#/components/schemas/ResolveWorkflowSessionAction_resource"},"reason":{"description":"The reason why the Action is marked as resolved.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","example":"Manual verification.","format":"safe-string","maxLength":150,"nullable":true,"type":"string"}},"required":["resource"],"type":"object"},"WorkflowTemplate":{"properties":{"id":{"description":"Unique identifier of the Workflow Template.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"name":{"description":"Name of the Workflow Template.","example":"Customer Onboarding","type":"string"},"action_groups":{"description":"List of the Action Groups contained in the Workflow Template. The Action Groups will determine what Actions the end users will have to go through to complete the Workflow Session.","items":{"$ref":"#/components/schemas/WorkflowTemplate_action_groups_inner"},"type":"array"},"workspaces":{"description":"List of Workspaces that define where the Workflow Template is scoped. The scoping determines which Workspace a Workflow Session created from this Template will belong to. Behavior varies depending on whether the Template is scoped to one, multiple, or no Workspaces.","items":{"$ref":"#/components/schemas/WorkflowTemplate_workspaces_inner"},"type":"array"}},"required":["action_groups","id","name","workspaces"],"title":"A Workflow Template","type":"object"},"Workspace":{"properties":{"id":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"external_name":{"nullable":true,"type":"string"},"default":{"type":"boolean"},"created_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"},"updated_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"},"deleted_at":{"format":"date-time","nullable":true,"readOnly":true,"type":"string"},"users":{"items":{"$ref":"#/components/schemas/Workspace_users_inner"},"type":"array"}},"required":["created_at","default","deleted_at","external_name","id","name","updated_at","users"],"title":"Workspace","type":"object"},"CreateWorkspace":{"additionalProperties":false,"properties":{"name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Sales","format":"safe-string","maxLength":200,"type":"string"},"external_name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"UK Sales","format":"safe-string","maxLength":200,"nullable":true,"type":"string"}},"required":["name"],"type":"object"},"MarkWorkspaceAsDefault":{"additionalProperties":false,"properties":{"workspace_id":{"description":"The workspace you want to mark as the default one","format":"uuid","type":"string"}},"required":["workspace_id"],"type":"object"},"DeleteWorkspace":{"additionalProperties":false,"properties":{"workspace_id":{"description":"The target workspace where resources are migrated in.","format":"uuid","type":"string"}},"required":["workspace_id"],"type":"object"},"UpdateWorkspace":{"properties":{"name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"Sales","format":"safe-string","maxLength":200,"type":"string"},"external_name":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","example":"UK Sales","format":"safe-string","maxLength":200,"nullable":true,"type":"string"}},"type":"object"},"KycAddonConsumptionsName":{"enum":["bank_account_connection_verification","bank_account_lookup_verification","bank_account_verification","company_verification","company_de_verification","company_it_verification","document_analysis_verification","document_analysis_tax_notice_verification","document_trust_advanced_verification","document_trust_standard_verification","identity_document_verification","identity_video_face_recognition_verification","certified_identity_pvid","identity_video_verification","proof_of_address_verification","watchlist_verification"],"type":"string"},"HumanName":{"pattern":"^(?!\\s)[0-9A-Za-zĄÀÁÂÃÄÅÇĆÈÉÊËĘÌÍÎÏŁÑŃÒÓÔÕÖŚÙÚÛÜÝŹŻąàáâãäåæçćèéêëęìíîïłñńòóôõöśùúûüýÿźżßĀāĂăĈĉĊċČčĎďĐđĒēĔĕĖėĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıIJijĴĵĶķĸĹĺĻļĽľĿŀŅņŇňʼnŊŋŌōŎŏŐőŒœŔŕŖŗŘřŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŽžſøØÆȘșȚț`'() -]+(?<!\\s)$","type":"string"},"Locale":{"description":"Locale settings used for communication.","enum":["en","fr","de","it","nl","es","pl","pt","ro"],"minLength":1,"title":"Locale","type":"string"},"CustomExperience_DisabledNotificationsType":{"enum":["approver.expiration_date_reminder","approver.canceled","approver.expiration_date_updated","approver.notified","approver.approved","approver.rejected","approver.declined","follower.approved","follower.canceled","follower.completed","follower.expired","follower.rejected","follower.activated","follower.signed","follower.declined","sender.approved","sender.canceled","sender.completed","sender.rejected","sender.signed","sender.declined","signer.expiration_date_reminder","signer.canceled","signer.completed","signer.signed","signer.expiration_date_updated","signer.signature_requested","signer.declined"],"example":"approver.canceled","type":"string"},"CustomExperience_Source":{"description":"Custom Experience Source","enum":["app","public_api"],"example":"app","nullable":true,"type":"string"},"CustomExperience_EmbeddedPreparationNavigationBar":{"additionalProperties":false,"description":"Navigation bar of the Embedded Preparation page.\nAn explicit `null` hides the whole navigation bar and both button settings are then ignored.\n","nullable":true,"properties":{"done_button":{"default":true,"description":"If true, the `Done` button is displayed in the navigation bar.","type":"boolean"},"back_button":{"default":false,"description":"If true, the `Back` button is displayed in the navigation bar.","type":"boolean"}},"title":"CustomExperience_EmbeddedPreparationNavigationBar","type":"object"},"LogoLayout":{"description":"Determines the display layout of the logo. Possible values are:\n- `round`: Displays the logo in a circular format.\n- `original`: Displays the logo in its original shape.\n","enum":["round","original"],"example":"round","title":"LogoLayout","type":"string"},"CustomPropertyOptionInput":{"properties":{"value":{"description":"Display text of the option.","example":"Quote","maxLength":255,"minLength":1,"type":"string"},"is_default":{"default":false,"description":"Whether this option is pre-selected on new SRs.\nMultiple defaults allowed if multiple_answer_allowed is true.\n","type":"boolean"},"position":{"description":"Sort order (0-based). If omitted, values are ordered as provided.\n","example":0,"minimum":0,"type":"integer"}},"required":["value"],"title":"CustomPropertyOptionInput","type":"object"},"CustomPropertyOption":{"properties":{"id":{"description":"Unique identifier of the option","format":"uuid","type":"string"},"value":{"description":"Display text of the option","type":"string"},"is_default":{"description":"Whether this option is pre-selected on new SRs","type":"boolean"},"position":{"description":"Sort order","type":"integer"}},"required":["id","is_default","position","value"],"title":"CustomPropertyOption","type":"object"},"CustomPropertyOptionUpdate":{"properties":{"id":{"description":"Include for existing options to preserve them.\nOmit for new options (a new id will be generated).\n","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","format":"uuid","type":"string"},"value":{"description":"Display text of the option.","example":"Sales Quote","maxLength":255,"minLength":1,"type":"string"},"is_default":{"default":false,"description":"Whether this option is pre-selected on new SRs.\nMultiple defaults allowed if multiple_answer_allowed is true.\n","type":"boolean"},"position":{"description":"Sort order (0-based). If omitted, values are ordered as provided.\n","example":0,"minimum":0,"type":"integer"}},"required":["value"],"title":"CustomPropertyOptionUpdate","type":"object"},"WorkflowSessionId":{"description":"Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.\n","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","nullable":true,"title":"Workflow Session identifier","type":"string"},"PreviousAttemptId":{"description":"ID of the previous attempt within the same `workflow_session_id`.\nAllows continuity between multiple attempts of the same Action.\nNull if this is the first attempt.\n","example":"9412b83b-b4b9-4a94-97b5-2b43dfa4cde4","format":"uuid","nullable":true,"title":"Previous Attempt identifier","type":"string"},"DocumentAnalysisStatus":{"description":"Status of the Document Analysis.","enum":["pending","awaiting_data","done","inconclusive","failed"],"example":"done","type":"string"},"DocumentAnalysisType":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["social_security","company_certificate","business_registration_certificate","driver_licence","rne_certificate","temporary_vehicle_registration_document","vehicle_registration_document","auto_insurance_claims_history","tax_notice","payslip","invoice","proof_of_address","id_document"],"example":"social_security","type":"string"},"AnalysisType":{"additionalProperties":false,"description":"Controls what the Document Analysis performs.\n\n- When `extraction` is `true` (default), data is extracted from the document and a document `type` is **required**.\n- When `extraction` is `false` (fraud-only), no `type` must be provided and `fraud_level` must be `advanced`.\n","properties":{"extraction":{"default":true,"description":"Whether to extract data from the document. Defaults to `true` when omitted.\nSet to `false` to run a fraud-only analysis (no data extraction).\n","example":true,"type":"boolean"},"fraud_level":{"description":"Level of fraud detection to run. `null` (default) disables fraud detection.\nNot supported for type `tax_notice`. Must be `advanced` when `extraction` is `false`.\n","enum":["none","standard","advanced"],"example":"advanced","nullable":true,"type":"string"}},"title":"AnalysisType","type":"object"},"FraudRiskAnalysis":{"additionalProperties":false,"description":"Result of the fraud detection analysis. `null` when no fraud detection verdict is available\n(e.g. fraud detection was not requested, or is still in progress).\n","nullable":true,"properties":{"risk_level":{"description":"Overall fraud risk level of the document. `null` when not yet determined.","enum":["high","medium","low","trusted"],"example":"low","nullable":true,"type":"string"},"indicators":{"description":"List of fraud indicators detected on the document.","items":{"$ref":"#/components/schemas/FraudRiskAnalysis_indicators_inner"},"type":"array"}},"required":["indicators","risk_level"],"title":"FraudRiskAnalysis","type":"object"},"InitiateSocialSecurity":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["social_security"],"example":"social_security","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateSocialSecurity_checks"}},"required":["file","type"],"title":"Initiate Social Security","type":"object"},"InitiateCompanyCertificate":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["company_certificate"],"example":"company_certificate","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateCompanyCertificate_checks"}},"required":["file","type"],"title":"Initiate Company Certificate","type":"object"},"InitiateBusinessRegistrationCertificate":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["business_registration_certificate"],"example":"business_registration_certificate","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateSocialSecurity_checks"}},"required":["file","type"],"title":"Initiate Business Registration Certificate","type":"object"},"InitiateDriverLicence":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["driver_licence"],"example":"driver_licence","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateSocialSecurity_checks"}},"required":["file","type"],"title":"Initiate Driver Licence","type":"object"},"InitiateRNECertificate":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["rne_certificate"],"example":"rne_certificate","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateCompanyCertificate_checks"}},"required":["file","type"],"title":"Initiate RNE Certificate","type":"object"},"InitiateTemporaryVehicleRegistrationDocument":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["temporary_vehicle_registration_document"],"example":"temporary_vehicle_registration_document","type":"string"},"country_code":{"description":"The country code of the document.\nCurrently only Italian temporary vehicle registration documents are supported.\n","enum":["IT"],"example":"IT","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateTemporaryVehicleRegistrationDocument_checks"}},"required":["country_code","file","type"],"title":"Initiate Temporary Vehicle Registration Document","type":"object"},"InitiateVehicleRegistrationDocument":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["vehicle_registration_document"],"example":"vehicle_registration_document","type":"string"},"country_code":{"description":"The country code of the vehicle registration document.","enum":["FR","IT"],"example":"FR","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateVehicleRegistrationDocument_checks"}},"required":["country_code","file","type"],"title":"Initiate Vehicle Registration Document","type":"object"},"InitiateAutoInsuranceClaimsHistory":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["auto_insurance_claims_history"],"example":"auto_insurance_claims_history","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateAutoInsuranceClaimsHistory_checks"}},"required":["file","type"],"title":"Initiate Auto Insurance Claims History","type":"object"},"InitiateTaxNotice":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["tax_notice"],"example":"tax_notice","type":"string"},"country_code":{"description":"The country code of the tax notice.","enum":["FR","DE","IT"],"example":"FR","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiateTaxNotice_checks"}},"required":["country_code","file","type"],"title":"Initiate Tax Notice","type":"object"},"InitiatePayslip":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 25 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["payslip"],"example":"payslip","type":"string"},"country_code":{"description":"The country code of the payslip.","enum":["FR","IT"],"example":"FR","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"analysis_type":{"$ref":"#/components/schemas/AnalysisTypeMultipart"},"checks":{"$ref":"#/components/schemas/InitiatePayslip_checks"}},"required":["country_code","file","type"],"title":"Initiate Payslip","type":"object"},"InitiateInvoice":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 10 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["invoice"],"example":"invoice","type":"string"},"country_code":{"description":"The country code of the invoice.","enum":["FR","IT","DE"],"example":"FR","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"checks":{"$ref":"#/components/schemas/InitiateInvoice_checks"}},"required":["country_code","file","type"],"title":"Initiate Invoice Document","type":"object"},"InitiateProofOfAddress_1":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 10 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["proof_of_address"],"example":"proof_of_address","type":"string"},"country_code":{"description":"The country code of the proof of address.","enum":["IT","DE"],"example":"IT","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"checks":{"$ref":"#/components/schemas/InitiateProofOfAddress_1_checks"}},"required":["country_code","file","type"],"title":"Initiate Proof of Address Document","type":"object"},"InitiateIdDocument":{"additionalProperties":false,"properties":{"file":{"description":"The file containing the data to extract.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 10 MB.\nMax number of pages per PDF: 10.\n","example":"Binary file","format":"binary","type":"string"},"type":{"description":"Type of document you want to analyze. Will be used to match the detected document type.","enum":["id_document"],"example":"id_document","type":"string"},"country_code":{"description":"The country code of the ID document.","enum":["DE"],"example":"DE","type":"string"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["country_code","file","type"],"title":"Initiate ID Document","type":"object"},"InitiateFraudOnly":{"additionalProperties":false,"description":"Fraud-only Document Analysis (no data extraction).\nSend `analysis_type[extraction]=false` and `analysis_type[fraud_level]=advanced`, with no `type`.\n","properties":{"file":{"description":"The file to run fraud detection on.\nAccepted formats: PDF, PNG, JPG, JPEG.\nMax size: 10 MB.\nMax number of pages for PDF: 2.\n","example":"Binary file","format":"binary","type":"string"},"analysis_type":{"$ref":"#/components/schemas/InitiateFraudOnly_analysis_type"},"workspace_id":{"description":"Scopes the Document Analysis to a specific workspace.\nDefaults to the default workspace if not specified.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["analysis_type","file"],"title":"Initiate Fraud Only","type":"object"},"DocumentAnalysisMeta_1":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"workspace_id":{"description":"The Workspace ID in which the Document Analysis has been created.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"created_at":{"description":"Creation date of the Document Analysis.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Update date of the Document Analysis.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"status":{"$ref":"#/components/schemas/DocumentAnalysisStatus"},"status_codes":{"description":"List of status codes. Indicates the cause when the status is `failed`.\n\n`DA_1001` is **deprecated**: it is still emitted alongside more specific check-failure codes (e.g. `DA_2001`, `DA_2002`) for backward compatibility. New integrations should rely on the specific codes.\n","example":[],"items":{"enum":["DA_1001","DA_1002","DA_1003","DA_1004","DA_1005","DA_1100","DA_1201","DA_1202","DA_1301","DA_1302","DA_1303","DA_1304","DA_1401","DA_1402","DA_1403","DA_2001","DA_2002","DA_2301","DA_2302","DA_2401","DA_2402","DA_3001","DA_3003","DA_3004"],"type":"string"},"type":"array"},"country_code":{"description":"The country code associated with the document analysis.\nNull for document types that don't require a country code.\n","nullable":true,"type":"string","example":null},"applicant_id":{"$ref":"#/components/schemas/WorkflowSessionApplicantId"},"data_anonymized":{"description":"Indicates if the personal data extracted from the document has been anonymized.\nIf set to `true`, the personal data has been anonymized and most fields will be NULL.\n","example":false,"type":"boolean"},"analysis_type":{"$ref":"#/components/schemas/AnalysisType"},"fraud_risk_analysis":{"$ref":"#/components/schemas/FraudRiskAnalysis"}},"required":["applicant_id","country_code","created_at","data_anonymized","id","previous_attempt_id","status","status_codes","updated_at","workflow_session_id","workspace_id"],"title":"DocumentAnalysisMeta","type":"object"},"SocialSecurityExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"social_security_number":"1234567890123","first_name":"John","last_name":"Doe","full_name":"John Doe","document_type":"carte vitale"},"properties":{"social_security_number":{"description":"Social Security number extracted from the document.","nullable":true,"type":"string"},"first_name":{"description":"First name of the individual.","nullable":true,"type":"string"},"last_name":{"description":"Last name of the individual.","nullable":true,"type":"string"},"full_name":{"description":"Full name of the individual.","nullable":true,"type":"string"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["document_type","first_name","full_name","last_name","social_security_number"],"title":"Social Security Extraction","type":"object"},"SocialSecurityCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["full_name"],"title":"Social Security Checks","type":"object"},"CompanyCertificateExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"verification_number":"1234567890123","company_name":"Acme","company_number":"1234567890","registered_address":"1 rue de la paix, 75000 Paris","issuance_date":"2025-01-01","legal_representatives":[{"type":"natural_person","first_name":"John","last_name":"Doe","full_name":"John Doe","function":"Président","company_name":null,"company_number":null},{"type":"legal_person","first_name":null,"last_name":null,"full_name":null,"company_name":"Acme Studio","company_number":"0987654321","function":"Dirigeant"}],"document_type":"Kbis"},"properties":{"verification_number":{"description":"Verification number extracted from the document.","nullable":true,"type":"string"},"company_name":{"description":"Company name extracted from the document.","nullable":true,"type":"string"},"company_number":{"description":"Company number extracted from the document.","nullable":true,"type":"string"},"registered_address":{"description":"Registered address extracted from the document.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date extracted from the document.","nullable":true,"type":"string"},"legal_representatives":{"description":"List of legal representatives extracted from the document.","items":{"$ref":"#/components/schemas/CompanyCertificateExtraction_legal_representatives_inner"},"type":"array"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["company_name","company_number","document_type","issuance_date","legal_representatives","registered_address","verification_number"],"title":"Company Certificate Extraction","type":"object"},"CompanyCertificateCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"legal_representatives":[{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}]},"nullable":true,"properties":{"legal_representatives":{"items":{"$ref":"#/components/schemas/CompanyCertificateCheck_legal_representatives_inner"},"nullable":true,"type":"array"}},"required":["legal_representatives"],"title":"Company Certificate Checks","type":"object"},"BusinessRegistrationCertificateExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"issuance_date":"2025-01-01","company_description":{"active":true,"legal_form":"Entreprise individuelle","company_name":null,"company_number":"123 4567 890","headquarter_company_number":"123 4567 890 12345","first_name":"John","last_name":"Doe","full_name":"John Doe"},"branch_description":{"active":true,"branch_company_number":"123 4567 890 12345","address":"1 rue de la paix, 75000 Paris","city":"Paris","postal_code":"75000"},"document_type":"Avis de situation"},"properties":{"issuance_date":{"description":"Issuance date extracted from the document.","nullable":true,"type":"string"},"company_description":{"$ref":"#/components/schemas/BusinessRegistrationCertificateExtraction_company_description"},"branch_description":{"$ref":"#/components/schemas/BusinessRegistrationCertificateExtraction_branch_description"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["branch_description","company_description","document_type","issuance_date"],"title":"Business Registration Certificate Extraction","type":"object"},"BusinessRegistrationCertificateCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["full_name"],"title":"Business Registration Certificate Checks","type":"object"},"DriverLicenceExtraction":{"additionalProperties":false,"example":{"first_name":"John","last_name":"Doe","full_name":"John Doe","born_on":"1990-01-15","expired_on":"2030-12-31","license_type":["B","A1"],"document_type":"permis de conduire français"},"properties":{"first_name":{"description":"First name of the individual.","nullable":true,"type":"string"},"last_name":{"description":"Last name of the individual.","nullable":true,"type":"string"},"full_name":{"description":"Full name of the individual.","nullable":true,"type":"string"},"born_on":{"description":"Date of birth of the individual.","format":"date","nullable":true,"type":"string"},"expired_on":{"description":"Expiration date of the driver licence.","format":"date","nullable":true,"type":"string"},"license_type":{"description":"List of license types.","items":{"type":"string"},"nullable":true,"type":"array"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["born_on","document_type","expired_on","first_name","full_name","last_name","license_type"],"title":"Driver Licence Extraction","type":"object"},"DriverLicenceCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["full_name"],"title":"Driver Licence Checks","type":"object"},"RNECertificateExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"company_name":"ACME Corp","company_number":"123456789","registered_address":"1 rue de la paix, 75000 Paris","issuance_date":"2024-01-15","legal_representatives":[{"type":"natural_person","first_name":"John","last_name":"Doe","full_name":"John Doe","function":"President","company_name":null,"company_number":null},{"type":"legal_person","first_name":null,"last_name":null,"full_name":null,"company_name":"ACME Studio","company_number":"0987654321","function":"Statutory Auditor"}],"document_type":"Attestation RNE"},"properties":{"company_name":{"description":"Company name extracted from the document.","nullable":true,"type":"string"},"company_number":{"description":"Company number extracted from the document.","nullable":true,"type":"string"},"registered_address":{"description":"Registered address extracted from the document.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date extracted from the document.","format":"date","nullable":true,"type":"string"},"legal_representatives":{"description":"List of legal representatives extracted from the document.","items":{"$ref":"#/components/schemas/CompanyCertificateExtraction_legal_representatives_inner"},"type":"array"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["company_name","company_number","document_type","issuance_date","legal_representatives","registered_address"],"title":"RNE Certificate Extraction","type":"object"},"RNECertificateCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"legal_representatives":[{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}]},"nullable":true,"properties":{"legal_representatives":{"items":{"$ref":"#/components/schemas/CompanyCertificateCheck_legal_representatives_inner"},"nullable":true,"type":"array"}},"required":["legal_representatives"],"title":"RNE Certificate Checks","type":"object"},"TemporaryVehicleRegistrationDocumentExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"vehicle_category":"M1","vehicle_license_number":"DH000SJ","vehicle_identification_number":"ZFA19900001244827","vehicle_purpose":"PROPRIO","vehicle_first_registration_year":"2018","vehicle_owner_information":{"vehicle_owner_full_name":"DOE JOHN","vehicle_owner_birth_date":"1985-06-15","vehicle_owner_address":"VIA ROMA 10, 00100 ROMA RM"},"other_details":"Veicolo ad uso privato","issuance_date":"2024-03-15","document_reason":"PASSAGGIO DI PROPRIETA","document_recipient_information":{"document_recipient_full_name":"DOE JOHN","document_recipient_address":"VIA ROMA 10, 00100 ROMA RM","document_recipient_birth_date":"1985-06-15","document_recipient_birth_city":"ROMA"}},"properties":{"vehicle_category":{"description":"Vehicle category extracted from the document.","nullable":true,"type":"string"},"vehicle_license_number":{"description":"Vehicle license plate number extracted from the document.","nullable":true,"type":"string"},"vehicle_identification_number":{"description":"Vehicle identification number (VIN) extracted from the document.","nullable":true,"type":"string"},"vehicle_purpose":{"description":"Vehicle purpose extracted from the document.","nullable":true,"type":"string"},"vehicle_first_registration_year":{"description":"Year of the vehicle's first registration extracted from the document.","nullable":true,"type":"string"},"vehicle_owner_information":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction_vehicle_owner_information"},"other_details":{"description":"Other details extracted from the document.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date extracted from the document.","format":"date","nullable":true,"type":"string"},"document_reason":{"description":"Document reason extracted from the document.","nullable":true,"type":"string"},"document_recipient_information":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentExtraction_document_recipient_information"}},"required":["document_reason","document_recipient_information","issuance_date","other_details","vehicle_category","vehicle_first_registration_year","vehicle_identification_number","vehicle_license_number","vehicle_owner_information","vehicle_purpose"],"title":"Temporary Vehicle Registration Document Extraction","type":"object"},"TemporaryVehicleRegistrationDocumentCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"vehicle_owner":{"owner_name":{"extracted":"DOE JOHN","expected":"Doe John","match_level":"exact"}}},"nullable":true,"properties":{"vehicle_owner":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentCheck_vehicle_owner"}},"required":["vehicle_owner"],"title":"Temporary Vehicle Registration Document Checks","type":"object"},"FrenchVehicleRegistrationDocumentExtraction":{"additionalProperties":false,"description":"Extracted data from a French vehicle registration document.","properties":{"licence_plate_number":{"description":"Licence plate number of the vehicle.","nullable":true,"type":"string"},"first_registration_date":{"description":"Date of first registration of the vehicle.","format":"date","nullable":true,"type":"string"},"owner_information":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_owner_information"},"co_owner_information":{"description":"List of co-owners of the vehicle.","items":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner"},"type":"array"},"vehicle_information":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_information"},"vehicle_identification_number":{"description":"Vehicle Identification Number (VIN).","nullable":true,"type":"string"},"vehicle_max_weight":{"description":"Maximum weight of the vehicle.","nullable":true,"type":"number"},"vehicle_motor_information":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_motor_information"},"document_number":{"description":"Document number.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date of the document.","format":"date","nullable":true,"type":"string"},"vehicle_next_inspection_date":{"description":"Date of the next vehicle inspection.","format":"date","nullable":true,"type":"string"},"mrz_line_1":{"description":"First line of the Machine Readable Zone (MRZ).","nullable":true,"type":"string"},"mrz_line_2":{"description":"Second line of the Machine Readable Zone (MRZ).","nullable":true,"type":"string"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"}},"required":["co_owner_information","document_number","document_type","first_registration_date","issuance_date","licence_plate_number","mrz_line_1","mrz_line_2","owner_information","vehicle_identification_number","vehicle_information","vehicle_max_weight","vehicle_motor_information","vehicle_next_inspection_date"],"title":"French Vehicle Registration Document Extraction","type":"object"},"VehicleRegistrationDocumentCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"vehicle_owner":{"owner_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"}}},"nullable":true,"properties":{"vehicle_owner":{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentCheck_vehicle_owner"}},"required":["vehicle_owner"],"title":"Vehicle Registration Document Checks","type":"object"},"ItalianVehicleRegistrationDocumentExtraction":{"additionalProperties":false,"description":"Extracted data from an Italian vehicle registration document.","properties":{"licence_plate_number":{"description":"Licence plate number of the vehicle.","nullable":true,"type":"string"},"first_registration_date":{"description":"Date of first registration of the vehicle.","format":"date","nullable":true,"type":"string"},"owner_information":{"$ref":"#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_owner_information"},"co_owner_information":{"description":"List of co-owners of the vehicle.","items":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner"},"type":"array"},"deed_informations":{"description":"List of deed informations related to the vehicle.","items":{"$ref":"#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_deed_informations_inner"},"type":"array"},"vehicle_information":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction_vehicle_information"},"vehicle_body":{"description":"Body type of the vehicle.","nullable":true,"type":"string"},"vehicle_identification_number":{"description":"Vehicle Identification Number (VIN).","nullable":true,"type":"string"},"vehicle_total_mass":{"description":"Total mass of the vehicle.","nullable":true,"type":"number"},"vehicle_motor_information":{"$ref":"#/components/schemas/ItalianVehicleRegistrationDocumentExtraction_vehicle_motor_information"},"document_type":{"description":"Classification label extracted from the document.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date of the document.","format":"date","nullable":true,"type":"string"},"vehicle_approval_number":{"description":"Vehicle approval number.","nullable":true,"type":"string"},"vehicle_destination_and_use":{"description":"Destination and use of the vehicle.","nullable":true,"type":"string"},"international_vehicle_category":{"description":"International vehicle category.","nullable":true,"type":"string"},"mass_of_the_vehicle_in_service":{"description":"Mass of the vehicle in service.","nullable":true,"type":"number"},"vehicle_maximum_technical_mass":{"description":"Maximum technical mass of the vehicle.","nullable":true,"type":"number"},"vehicle_maximum_permissible_mass":{"description":"Maximum permissible mass of the vehicle.","nullable":true,"type":"number"}},"required":["co_owner_information","deed_informations","document_type","first_registration_date","international_vehicle_category","issuance_date","licence_plate_number","mass_of_the_vehicle_in_service","owner_information","vehicle_approval_number","vehicle_body","vehicle_destination_and_use","vehicle_identification_number","vehicle_information","vehicle_maximum_permissible_mass","vehicle_maximum_technical_mass","vehicle_motor_information","vehicle_total_mass"],"title":"Italian Vehicle Registration Document Extraction","type":"object"},"AutoInsuranceClaimsHistoryExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","example":{"policy_holder_full_name":"John Doe","policy_holder_address":"1 rue de la Paix, 75001 Paris","policy_holder_birth_date":"1990-01-01","insurance_score":"0.50","issuance_date":"2024-01-15","effective_start_date":"2023-01-01","active_contract":true,"contract_cancellation_date":null,"vehicle_model":"Renault Clio","vehicle_license_plate":"AB-123-CD","drivers_information":[{"driver_full_name":"John Doe","driver_birth_date":"1990-01-01","coverage_start_date":"2023-01-01","coverage_end_date":null,"driver_license_number":"12345678","driver_license_category":"B","driver_license_issuance_date":"2010-06-15"}],"incidents_information":[]},"properties":{"policy_holder_full_name":{"description":"Full name of the policy holder extracted from the document.","nullable":true,"type":"string"},"policy_holder_address":{"description":"Address of the policy holder extracted from the document.","nullable":true,"type":"string"},"policy_holder_birth_date":{"description":"Birth date of the policy holder extracted from the document.","format":"date","nullable":true,"type":"string"},"insurance_score":{"description":"Insurance score (bonus/malus coefficient) extracted from the document.","nullable":true,"type":"string"},"issuance_date":{"description":"Issuance date of the document.","format":"date","nullable":true,"type":"string"},"effective_start_date":{"description":"Effective start date of the insurance contract.","format":"date","nullable":true,"type":"string"},"active_contract":{"description":"Whether the insurance contract is currently active.","nullable":true,"type":"boolean"},"contract_cancellation_date":{"description":"Cancellation date of the insurance contract, if applicable.","format":"date","nullable":true,"type":"string"},"vehicle_model":{"description":"Model of the insured vehicle extracted from the document.","nullable":true,"type":"string"},"vehicle_license_plate":{"description":"License plate number of the insured vehicle extracted from the document.","nullable":true,"type":"string"},"drivers_information":{"description":"List of drivers covered by the insurance policy.","items":{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryExtraction_drivers_information_inner"},"nullable":true,"type":"array"},"incidents_information":{"description":"List of incidents (claims) recorded in the insurance history.","items":{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryExtraction_incidents_information_inner"},"nullable":true,"type":"array"}},"required":["active_contract","contract_cancellation_date","drivers_information","effective_start_date","incidents_information","insurance_score","issuance_date","policy_holder_address","policy_holder_birth_date","policy_holder_full_name","vehicle_license_plate","vehicle_model"],"title":"Auto Insurance Claims History Extraction","type":"object"},"AutoInsuranceClaimsHistoryCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"policy_holder":{"owner_name":{"extracted":"Doe John","expected":"Doe John","match_level":"exact"}}},"nullable":true,"properties":{"policy_holder":{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryCheck_policy_holder"}},"required":["policy_holder"],"title":"Auto Insurance Claims History Checks","type":"object"},"FrenchTaxNoticeExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"full_name":{"description":"The holder full name extracted from the document.","example":"Doe John","nullable":true,"type":"string"},"fiscal_number_1":{"description":"The fiscal number of the first declarant extracted from the document.","example":"0312345678901","nullable":true,"type":"string"},"fiscal_number_2":{"description":"The fiscal number of the second declarant extracted from the document.","example":"0398765432109","nullable":true,"type":"string"},"tax_notice_reference":{"description":"The tax notice reference number extracted from the document.","example":"2412B01234567","nullable":true,"type":"string"},"issuance_date":{"description":"The tax notice issuance date extracted from the document.","example":"2025-08-15","format":"date","nullable":true,"type":"string"},"income_year":{"description":"Year of incomes (usually the year before document issuance) extracted from the document.","example":2024,"nullable":true,"type":"integer"},"reference_income":{"description":"The fiscal reference income extracted from the document.","example":30000,"nullable":true,"type":"integer"},"document_type":{"description":"The document type extracted from the document.","enum":["Avis d'impôts sur le revenu"],"example":"Avis d'impôts sur le revenu","nullable":true,"type":"string"},"2d_doc":{"$ref":"#/components/schemas/FrenchTaxNoticeExtraction_2d_doc"}},"required":["2d_doc","document_type","fiscal_number_1","fiscal_number_2","full_name","income_year","issuance_date","reference_income","tax_notice_reference"],"title":"French Tax Notice Extraction","type":"object"},"TaxNoticeCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"},"income_year":{"extracted":2024,"expected":2024,"match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"},"income_year":{"$ref":"#/components/schemas/TaxNoticeCheck_income_year"}},"title":"Tax Notice Checks","type":"object"},"GermanTaxNoticeExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"full_name_1":{"description":"The holder full name of the first declarant extracted from the document.","example":"Müller Hans","nullable":true,"type":"string"},"full_name_2":{"description":"The holder full name of the second declarant extracted from the document.","example":"Müller Anna","nullable":true,"type":"string"},"fiscal_number_1":{"description":"The tax identification number (IdNr) of the first declarant extracted from the document.","example":"01234567890","nullable":true,"type":"string"},"fiscal_number_2":{"description":"The tax identification number (IdNr) of the second declarant extracted from the document.","example":"10987654321","nullable":true,"type":"string"},"issuance_date":{"description":"The tax notice issuance date extracted from the document.","example":"2025-07-15","format":"date","nullable":true,"type":"string"},"income_year":{"description":"Year of incomes (usually the year before document issuance) extracted from the document.","example":2024,"nullable":true,"type":"integer"},"reference_income":{"description":"The taxable income (zu versteuerndes Einkommen) extracted from the document.","example":48000,"nullable":true,"type":"integer"},"document_type":{"description":"The document type extracted from the document.","enum":["Steuerbescheid"],"example":"Steuerbescheid","nullable":true,"type":"string"}},"required":["document_type","fiscal_number_1","fiscal_number_2","full_name_1","full_name_2","income_year","issuance_date","reference_income"],"title":"German Tax Notice Extraction","type":"object"},"ItalianTaxNoticeExtraction":{"additionalProperties":false,"description":"Extracted data from the document (Italian Certificazione Unica).","properties":{"employer_name":{"description":"The employer (sostituto d'imposta) name extracted from the document.","example":"MONTMARTRE S.R.L.","nullable":true,"type":"string"},"employer_codice_fiscale":{"description":"The employer Codice Fiscale (11 digits) extracted from the document.","example":"16961111008","nullable":true,"type":"string"},"employee_full_name":{"description":"The certified employee/pensioner full name extracted from the document.","example":"LE ROUX ARMAND","nullable":true,"type":"string"},"employee_codice_fiscale":{"description":"The certified employee/pensioner Codice Fiscale (16 characters) extracted from the document.","example":"LRXRND04H16Z110V","nullable":true,"type":"string"},"issuance_date":{"description":"The certification issuance date (firma del sostituto d'imposta) extracted from the document.","example":"2024-02-29","format":"date","nullable":true,"type":"string"},"income_year":{"description":"The income reference year (\"RELATIVA ALL'ANNO\") extracted from the document.","example":2023,"nullable":true,"type":"integer"},"reference_income":{"description":"The reference income (first filled of Punti 1-5) extracted from the document.","example":10708.6,"nullable":true,"type":"number"},"document_type":{"description":"The document type extracted from the document.","example":"Certificazione Unica","nullable":true,"type":"string"}},"required":["document_type","employee_codice_fiscale","employee_full_name","employer_codice_fiscale","employer_name","income_year","issuance_date","reference_income"],"title":"Italian Tax Notice Extraction","type":"object"},"PayslipExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"first_name":{"description":"The employee first name extracted from the document.","example":"Marie","nullable":true,"type":"string"},"last_name":{"description":"The employee last name extracted from the document.","example":"DUPONT","nullable":true,"type":"string"},"full_name":{"description":"The employee full name extracted from the document.","example":"MARIE DUPONT","nullable":true,"type":"string"},"employer_name":{"description":"The employer name extracted from the document.","example":"SNCF Réseau","nullable":true,"type":"string"},"pay_period_start_date":{"description":"The pay period start date extracted from the document.","example":"2026-03-01","format":"date","nullable":true,"type":"string"},"pay_period_end_date":{"description":"The pay period end date extracted from the document.","example":"2026-03-31","format":"date","nullable":true,"type":"string"},"net_pay":{"description":"The net salary extracted from the document.","example":2382.4,"nullable":true,"type":"number"},"gross_pay":{"description":"The gross salary extracted from the document.","example":3150,"nullable":true,"type":"number"},"document_type":{"description":"The document type extracted from the document.","example":"Payslip","nullable":true,"type":"string"}},"required":["document_type","employer_name","first_name","full_name","gross_pay","last_name","net_pay","pay_period_end_date","pay_period_start_date"],"title":"Payslip Extraction","type":"object"},"PayslipCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"MARIE DUPONT","expected":"Marie Dupont","match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"title":"Payslip Checks","type":"object"},"FrenchInvoiceExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"issuance_date":{"description":"The date the invoice was issued, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"invoice_number":{"description":"The invoice number extracted from the document.","example":"FA-2026-0042","nullable":true,"type":"string"},"invoice_date":{"description":"The date of the sale or service, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"seller_name":{"description":"The seller (issuer) name extracted from the document.","example":"Acme SAS","nullable":true,"type":"string"},"seller_address":{"description":"The seller (issuer) postal address extracted from the document.","example":"12 rue de la République 75001 Paris","nullable":true,"type":"string"},"seller_company_number":{"description":"The seller SIREN or SIRET number extracted from the document.","example":"882533086","nullable":true,"type":"string"},"vat_identification_number":{"description":"The seller intra-community VAT number extracted from the document.","example":"FR81882533086","nullable":true,"type":"string"},"billing_address":{"description":"The billing address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"shipping_address":{"description":"The shipping address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"buyer_name":{"description":"The buyer (customer) name extracted from the document.","example":"Marie Dupont","nullable":true,"type":"string"},"buyer_address":{"description":"The buyer (customer) postal address extracted from the document.","example":"59 avenue Ernest Renan 93100 Montreuil","nullable":true,"type":"string"},"total_excluding_taxes":{"description":"The total amount excluding taxes extracted from the document.","example":1127.5,"nullable":true,"type":"number"},"total_including_taxes":{"description":"The total amount including taxes extracted from the document.","example":1353,"nullable":true,"type":"number"},"document_type":{"description":"The document type extracted from the document.","example":"Facture","nullable":true,"type":"string"}},"required":["billing_address","buyer_address","buyer_name","document_type","invoice_date","invoice_number","issuance_date","seller_address","seller_company_number","seller_name","shipping_address","total_excluding_taxes","total_including_taxes","vat_identification_number"],"title":"French Invoice Extraction","type":"object"},"InvoiceCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"buyer_name":{"extracted":"ACME SAS","expected":"Acme SAS","match_level":"exact"}},"nullable":true,"properties":{"buyer_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"title":"Invoice Checks","type":"object"},"ItalianInvoiceExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"issuance_date":{"description":"The date the invoice was issued, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"invoice_number":{"description":"The invoice number extracted from the document.","example":"FT-2026-0042","nullable":true,"type":"string"},"invoice_date":{"description":"The date of the sale or service, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"seller_name":{"description":"The seller (issuer) name extracted from the document.","example":"Acme SRL","nullable":true,"type":"string"},"seller_address":{"description":"The seller (issuer) postal address extracted from the document.","example":"Via Roma 12 00100 Roma RM","nullable":true,"type":"string"},"seller_company_number":{"description":"The seller Partita IVA (11 digits) extracted from the document.","example":"01069490470","nullable":true,"type":"string"},"vat_identification_number":{"description":"The seller intra-community VAT number extracted from the document.","example":"IT01069490470","nullable":true,"type":"string"},"seller_codice_fiscale":{"description":"The seller Codice Fiscale extracted from the document.\nEither an 11-digit company number or a 16-character alphanumeric code for individuals.\n","example":"01069490470","nullable":true,"type":"string"},"billing_address":{"description":"The billing address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"shipping_address":{"description":"The shipping address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"buyer_name":{"description":"The buyer (customer) name extracted from the document.","example":"Mario Rossi","nullable":true,"type":"string"},"buyer_address":{"description":"The buyer (customer) postal address extracted from the document.","example":"Via Milano 5 20121 Milano MI","nullable":true,"type":"string"},"buyer_codice_fiscale":{"description":"The buyer Codice Fiscale extracted from the document, when the buyer is a company or professional.\nEither an 11-digit company number or a 16-character alphanumeric code for individuals. Null when absent.\n","example":"RSSMRA85T10A562S","nullable":true,"type":"string"},"total_excluding_taxes":{"description":"The total amount excluding taxes extracted from the document.","example":1127.5,"nullable":true,"type":"number"},"total_including_taxes":{"description":"The total amount including taxes extracted from the document.","example":1375.55,"nullable":true,"type":"number"},"document_type":{"description":"The document type extracted from the document.","example":"Fattura","nullable":true,"type":"string"}},"required":["billing_address","buyer_address","buyer_codice_fiscale","buyer_name","document_type","invoice_date","invoice_number","issuance_date","seller_address","seller_codice_fiscale","seller_company_number","seller_name","shipping_address","total_excluding_taxes","total_including_taxes","vat_identification_number"],"title":"Italian Invoice Extraction","type":"object"},"GermanInvoiceExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"issuance_date":{"description":"The date the invoice was issued, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"invoice_number":{"description":"The invoice number extracted from the document.","example":"RE-2026-0042","nullable":true,"type":"string"},"invoice_date":{"description":"The date of the sale or service, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"seller_name":{"description":"The seller (issuer) name extracted from the document.","example":"Muster GmbH","nullable":true,"type":"string"},"seller_address":{"description":"The seller (issuer) postal address extracted from the document.","example":"Musterstraße 1 10115 Berlin","nullable":true,"type":"string"},"seller_company_number":{"description":"The seller Handelsregisternummer (HRB/HRA) or Steuernummer extracted from the document.","example":"HRB 12345","nullable":true,"type":"string"},"vat_identification_number":{"description":"The seller intra-community VAT number extracted from the document.","example":"DE123456789","nullable":true,"type":"string"},"billing_address":{"description":"The billing address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"shipping_address":{"description":"The shipping address extracted from the document, when distinct.","nullable":true,"type":"string","example":null},"buyer_name":{"description":"The buyer (customer) name extracted from the document.","example":"Max Mustermann","nullable":true,"type":"string"},"buyer_address":{"description":"The buyer (customer) postal address extracted from the document.","example":"Beispielweg 5 80331 München","nullable":true,"type":"string"},"total_excluding_taxes":{"description":"The total amount excluding taxes extracted from the document.","example":1127.5,"nullable":true,"type":"number"},"total_including_taxes":{"description":"The total amount including taxes extracted from the document.","example":1353.2,"nullable":true,"type":"number"},"document_type":{"description":"The document type extracted from the document.","example":"Rechnung","nullable":true,"type":"string"}},"required":["billing_address","buyer_address","buyer_name","document_type","invoice_date","invoice_number","issuance_date","seller_address","seller_company_number","seller_name","shipping_address","total_excluding_taxes","total_including_taxes","vat_identification_number"],"title":"German Invoice Extraction","type":"object"},"ItalianProofOfAddressExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"first_name":{"description":"The first name of the certificate holder, extracted from the document.","example":"Mario","nullable":true,"type":"string"},"last_name":{"description":"The last name of the certificate holder, extracted from the document.","example":"Rossi","nullable":true,"type":"string"},"full_address":{"description":"The full residence address extracted from the document.","example":"Via Roma 1, 20100 Milano (MI)","nullable":true,"type":"string"},"issuance_date":{"description":"The date the certificate was issued, extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"seal_present":{"description":"Whether a qualified electronic seal or official stamp (Ministero dell'Interno / ANPR) was detected on the document.","example":true,"nullable":true,"type":"boolean"},"document_type":{"description":"The document type extracted from the document.","example":"Certificato di residenza","nullable":true,"type":"string"}},"required":["document_type","first_name","full_address","issuance_date","last_name","seal_present"],"title":"Italian Proof of Address Extraction","type":"object"},"ProofOfAddressCheck":{"additionalProperties":false,"description":"Checks performed on the document.","example":{"full_name":{"extracted":"Rossi Mario","expected":"Rossi Mario","match_level":"exact"}},"nullable":true,"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"title":"Proof of Address Checks","type":"object"},"GermanProofOfAddressExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"first_name":{"description":"The first name of the registered person, extracted from the document.","example":"Max","nullable":true,"type":"string"},"last_name":{"description":"The last name of the registered person, extracted from the document.","example":"Mustermann","nullable":true,"type":"string"},"full_address":{"description":"The full main residence address extracted from the document.","example":"Musterstraße 1, 10115 Berlin","nullable":true,"type":"string"},"residence_start_date":{"description":"The date since when the person has been living at the main residence (Einzugsdatum), extracted from the document.","example":"2020-01-01","format":"date","nullable":true,"type":"string"},"issuance_date":{"description":"The date the certificate was issued (Ausstellungsdatum), extracted from the document.","example":"2026-03-15","format":"date","nullable":true,"type":"string"},"document_type":{"description":"The document type extracted from the document.","example":"Meldebescheinigung","nullable":true,"type":"string"}},"required":["document_type","first_name","full_address","issuance_date","last_name","residence_start_date"],"title":"German Proof of Address Extraction","type":"object"},"IdDocumentExtraction":{"additionalProperties":false,"description":"Extracted data from the document.","properties":{"first_name":{"description":"The first name of the document holder, extracted from the document.","example":"John","nullable":true,"type":"string"},"last_name":{"description":"The last name of the document holder, extracted from the document.","example":"Doe","nullable":true,"type":"string"},"birth_name":{"description":"The birth name of the document holder, extracted from the document.","example":"Müller","nullable":true,"type":"string"},"birth_date":{"description":"The birth date of the document holder, extracted from the document.","example":"1990-01-15","format":"date","nullable":true,"type":"string"},"birth_location":{"description":"The birth location of the document holder, extracted from the document.","example":"Berlin","nullable":true,"type":"string"},"gender":{"description":"The gender of the document holder, extracted from the document (`m`, `f` or `x`).","example":"m","nullable":true,"type":"string"},"address":{"$ref":"#/components/schemas/IdDocumentExtraction_address"},"document_type":{"description":"The detected classification label of the document.","example":"Personalausweis","nullable":true,"type":"string"},"issuing_country_code":{"description":"The issuing country code extracted from the document.","example":"DE","format":"ISO 3166-1 alpha-2","nullable":true,"pattern":"^[A-Z]{2}$","type":"string"},"issuance_date":{"description":"The date the document was issued, extracted from the document.","example":"2020-03-15","format":"date","nullable":true,"type":"string"},"expiration_date":{"description":"The expiration date of the document, extracted from the document.","example":"2030-03-14","format":"date","nullable":true,"type":"string"},"document_number":{"description":"The document number, extracted from the document.","example":"L01X00T47","nullable":true,"type":"string"},"mrz":{"$ref":"#/components/schemas/IdDocumentExtraction_mrz"}},"required":["address","birth_date","birth_location","birth_name","document_number","document_type","expiration_date","first_name","gender","issuance_date","issuing_country_code","last_name","mrz"],"title":"ID Document Extraction","type":"object"},"InitialsArea":{"properties":{"alignment":{"description":"Alignment of the Initials on the document. The `left`, `right` and `center` options are aligned on top of the page by default.","enum":["left","right","center","top-left","top-right","top-center","bottom-left","bottom-right","bottom-center"],"type":"string"},"y":{"description":"Offset of the initials from the edge of the page (in pixels). The offset is from the top or bottom of the page, depending on what has been defined in the `alignment` attribute.","example":10,"minimum":0,"type":"integer"}},"required":["alignment","y"],"title":"InitialsArea","type":"object"},"DocumentExcludedApprovers":{"description":"List of Approver IDs who cannot see this Document. When omitted, all Approvers can see it (default). Only available when the document_visibility feature is enabled on the organization.\n","example":["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"],"items":{"format":"uuid","type":"string"},"type":"array"},"DocumentExcludedSigners":{"description":"List of Signer IDs who cannot see this Document. When omitted, all Signers can see it (default). Requires the document_visibility feature to be enabled on the organization.\n","example":["550e8400-e29b-41d4-a716-446655440000","6ba7b810-9dad-11d1-80b4-00c04fd430c8"],"items":{"format":"uuid","type":"string"},"type":"array"},"CreateElectronicSealFieldSealPayload":{"properties":{"type":{"enum":["seal","read_only_text"],"example":"seal","type":"string"},"height":{"example":200,"maximum":32767,"minimum":1,"type":"integer"},"width":{"example":250,"maximum":32767,"minimum":1,"type":"integer"},"page":{"example":1,"maximum":32767,"minimum":1,"type":"integer"},"x":{"example":0,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":0,"maximum":32767,"minimum":0,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"maxLength":200,"nullable":true,"type":"string"},"captions":{"description":"Optional captions to display on the seal image. Limited to one caption per field.","items":{"$ref":"#/components/schemas/CreateElectronicSealFieldSealPayload_captions_inner"},"maxItems":1,"nullable":true,"type":"array"}},"required":["height","page","type","width","x","y"],"title":"Seal","type":"object"},"CreateElectronicSealFieldReadOnlyTextPayload":{"properties":{"type":{"enum":["read_only_text"],"example":"read_only_text","type":"string"},"height":{"example":200,"maximum":32767,"minimum":1,"type":"integer"},"width":{"example":250,"maximum":32767,"minimum":1,"type":"integer"},"page":{"example":1,"maximum":32767,"minimum":1,"type":"integer"},"x":{"example":0,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":0,"maximum":32767,"minimum":0,"type":"integer"},"text":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).","format":"safe-string","maxLength":80,"type":"string"}},"required":["height","page","type","width","x","y"],"title":"Read Only Text","type":"object"},"SignatureRequestTimeZone":{"default":"Europe/Paris","description":"Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Europe/Paris.","example":"Europe/Paris","type":"string"},"AuditTrailLocale":{"enum":["de","en","es","fr","it","pt","ro"],"example":"en","type":"string"},"CustomPropertyInList":{"properties":{"id":{"description":"Unique identifier of the custom property.","format":"uuid","type":"string"},"name":{"description":"Display name of the property.","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/CustomPropertyType"}],"description":"Type of the custom property."},"required":{"description":"Whether users must fill this property before sending the SR via the application (not enforced via API).","type":"boolean"},"multiple_answer_allowed":{"description":"For list type only — whether multiple options can be selected. Null for text type.","nullable":true,"type":"boolean"},"workspace_ids":{"description":"List of workspace IDs where this property is applicable. Null means org-wide.","items":{"$ref":"#/components/schemas/UUID"},"nullable":true,"type":"array"},"default_value":{"description":"For text type only — default text pre-filled on new signature requests. Null for list type.","nullable":true,"type":"string"},"options":{"description":"For list type only: selectable options.\nNull for text type.\n","items":{"$ref":"#/components/schemas/CustomPropertyOption"},"nullable":true,"type":"array"}},"required":["id","name","type"],"title":"CustomPropertyInList","type":"object"},"SignatureRequest_SignerFromInfoInput":{"additionalProperties":false,"description":"Create a signer from info","properties":{"info":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_info"},"fields":{"description":"Fields placed on Documents for this Signer.","items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"signature_level":{"default":"electronic_signature","description":"Legal level of the electronic signature required from the Signer.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","type":"boolean"}},"required":["info","signature_level"],"title":"From Scratch","type":"object"},"SignatureRequest_SignerFromUserIdInput":{"additionalProperties":false,"description":"Create a signer from a user","properties":{"user_id":{"description":"Create signer from an existing user","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","type":"string"},"fields":{"description":"Fields placed on Documents for this Signer.","items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"signature_level":{"default":"electronic_signature","description":"Legal level of the electronic signature required from the Signer.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","type":"boolean"}},"required":["signature_level","user_id"],"title":"From Existing User","type":"object"},"SignatureRequest_SignerFromContactIdInput":{"additionalProperties":false,"description":"Create signer from a contact","properties":{"contact_id":{"description":"Create signer from an existing contact","example":"ddecfb85-8a45-4254-b940-6171b8df0a90","format":"uuid","type":"string"},"fields":{"description":"Fields placed on Documents for this Signer.","items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"signature_level":{"default":"electronic_signature","description":"Legal level of the electronic signature required from the Signer.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","type":"boolean"}},"required":["contact_id","signature_level"],"title":"From Existing Contact","type":"object"},"SignatureRequest_EmailNotification":{"additionalProperties":false,"description":"Email notification configuration for recipients.","minProperties":1,"nullable":true,"properties":{"sender":{"$ref":"#/components/schemas/SignatureRequest_EmailNotification_Sender"},"custom_note":{"deprecated":true,"description":"Deprecated; use `email_notification.custom_text` instead.","example":"Please sign these documents as soon as possible.","format":"safe-string","maxLength":2000,"nullable":true,"type":"string"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_EmailNotification_custom_text"}},"title":"SignatureRequest_EmailNotification","type":"object"},"SignatureRequest_EmbeddedPreparation":{"additionalProperties":false,"description":"Embedded Preparation settings for this Signature Request.","nullable":true,"properties":{"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_EmbeddedPreparation_redirect_urls"}},"title":"SignatureRequest_EmbeddedPreparation","type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromInfoInput":{"additionalProperties":false,"description":"Create a placeholder signer substitute from info","properties":{"label":{"description":"Placeholder label defined in the template to substitute.","example":"Employee","maxLength":64,"minLength":1,"type":"string"},"info":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info"},"signature_level":{"default":"electronic_signature","description":"Legal level of the electronic signature required from the substitute Signer.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"}},"required":["info","label"],"title":"From Scratch","type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput":{"additionalProperties":false,"description":"Create a placeholder signer substitute from a user","properties":{"label":{"description":"Placeholder label defined in the template to substitute.","example":"Employee","maxLength":64,"minLength":1,"type":"string"},"user_id":{"description":"Create signer from an existing user","example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","type":"string"},"signature_level":{"default":"electronic_signature","description":"Legal level of the electronic signature required from the substitute Signer.","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"}},"required":["label","user_id"],"title":"From Existing User","type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput":{"additionalProperties":false,"description":"Create a placeholder signer substitute from a contact","properties":{"label":{"example":"Employee","maxLength":64,"minLength":1,"type":"string"},"contact_id":{"description":"Create signer from an existing contact","example":"ddecfb85-8a45-4254-b940-6171b8df0a90","format":"uuid","type":"string"},"signature_level":{"default":"electronic_signature","enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":[null,"otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"}},"required":["contact_id","label"],"title":"From Existing Contact","type":"object"},"SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput":{"additionalProperties":false,"description":"Create a placeholder read_only_text field substitute","properties":{"label":{"description":"Placeholder label of the read-only text Field to substitute.","example":"Employee","maxLength":64,"minLength":1,"type":"string"},"text":{"description":"Text value substituted into the read-only text Field.","example":"This is my read_only_text","maxLength":5000,"minLength":1,"type":"string"}},"required":["label","text"],"type":"object"},"Archiving":{"description":"Once the signature request completed, archive its documents in a secure digital safe","enum":["archive","archive_y"],"nullable":true,"title":"Archiving","type":"string"},"CustomPropertyValue":{"properties":{"id":{"description":"ID of the Custom Property.","format":"uuid","type":"string"},"name":{"description":"Name of the Custom Property.","type":"string"},"type":{"description":"Type of the custom property.","enum":["text","list"],"type":"string"},"value":{"description":"Text value for text properties.","nullable":true,"type":"string"},"value_ids":{"description":"Array of option ids for list properties.","items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"},"values":{"description":"Array of option values for list properties.","items":{"type":"string"},"nullable":true,"type":"array"}},"required":["id","name","type"],"title":"CustomPropertyValue","type":"object"},"EmbeddedSignerWithSignatureLink":{"description":"","properties":{"id":{"description":"Unique identifier of the Signer.","format":"uuid","minLength":1,"type":"string"},"status":{"description":"Current status of the Signer.","enum":["initiated","notified","verified","processing","consent_given","signed","aborted","error"],"minLength":1,"type":"string"},"signature_link":{"description":"Signature link for the Signer; `null` when `delivery_mode` is `email`.","format":"uri","minLength":1,"nullable":true,"type":"string"},"signature_link_expiration_date":{"description":"Expiration timestamp of the signature link.","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"}},"required":["id","signature_link","signature_link_expiration_date","status"],"type":"object"},"ApproverToNotify":{"description":"","properties":{"id":{"description":"Unique identifier of the Approver.","format":"uuid","minLength":1,"type":"string"},"status":{"description":"Current status of the Approver.","enum":["initiated","notified","approved","rejected"],"minLength":1,"type":"string"},"approval_link":{"description":"Approval link for the Approver; `null` when `delivery_mode` is `email`.","format":"uri","minLength":1,"nullable":true,"type":"string"},"approval_link_expiration_date":{"description":"Expiration timestamp of the approval link.","example":"2024-01-18T22:59:00Z","format":"date-time","nullable":true,"type":"string"}},"required":["approval_link","approval_link_expiration_date","id","status"],"type":"object"},"CustomText":{"description":"Custom Text","properties":{"request_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"required":["reminder_body","reminder_subject","request_body","request_subject"],"type":"object"},"ExcludedDocuments":{"description":"List of Document IDs not visible to this Recipient. When omitted, the Recipient can see all Documents. Only available when the document_visibility feature is enabled on the organization.\n","example":["89120884-d29a-4b1a-ac7b-a9e73a872796","7c0c2d1e-3f4a-5b6c-8d9e-0f1a2b3c4d5e"],"items":{"format":"uuid","type":"string"},"type":"array"},"SignatureDisplay":{"description":"Controls what is shown within the signature field.","example":{"layout":"detailed","options":{"date_format":"dd/MM/yyyy","time_format":"HH:mm","show_timezone":true,"show_email":false}},"oneOf":[{"$ref":"#/components/schemas/SignatureDisplay_oneOf"},{"$ref":"#/components/schemas/SignatureDisplay_oneOf_1"}],"title":"SignatureDisplay","type":"object"},"Font":{"example":{"family":"Inconsolata","color":"#F53D1E","size":12,"variants":{"bold":true,"italic":false}},"properties":{"family":{"$ref":"#/components/schemas/FontFamily"},"color":{"pattern":"^#([a-f0-9]{6}|[A-F0-9]{6})$","type":"string"},"size":{"maximum":96,"minimum":7,"type":"integer"},"variants":{"$ref":"#/components/schemas/FontVariants"}},"required":["color","family","size","variants"],"title":"Font","type":"object"},"CreateFieldDateFormat":{"default":"dd/MM/yyyy","description":"Format used to display the date (e.g., `dd/MM/yyyy`, `MM/dd/yyyy`)","enum":["dd/MM/yyyy","dd-MM-yyyy","dd.MM.yyyy","yyyy-MM-dd","MM/dd/yyyy","dd MMMM yyyy","MMMM dd, yyyy","MMM dd, yyyy"],"example":"dd/MM/yyyy","title":"date_format","type":"string"},"CreateFieldTimeFormat":{"description":"Format used to display the time. Can be null to display only the date, or a format like `HH:mm` or `hh:mm a`","enum":[null,"HH:mm","hh:mm a"],"example":"HH:mm","nullable":true,"title":"time_format","type":"string"},"CreateFieldOffsetUnit":{"default":"days","description":"Unit of time used to offset the signature date. When `null`, the field will display the exact signature date.","enum":["days","weeks","months","years"],"example":"months","nullable":true,"title":"offset_unit","type":"string"},"CreateFieldNameFormat":{"default":"full_name","description":"Format used to display the signer's name.","enum":["full_name","first_name","last_name"],"example":"full_name","title":"name_format","type":"string"},"SignatureDisplay_1":{"description":"Controls what is shown within the signature field.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/Minimal_layout"},{"$ref":"#/components/schemas/Detailed_layout"}],"title":"SignatureDisplay","type":"object"},"CreateFieldFont":{"description":"If set, **width** and **height** properties become required. Otherwise, if not set or null, the default font will be used.","example":{"family":"Inconsolata","color":"#F53D1E","size":12,"variants":{"bold":true,"italic":false}},"nullable":true,"properties":{"family":{"$ref":"#/components/schemas/FontFamily"},"color":{"default":"#000000","pattern":"^#([a-f0-9]{6}|[A-F0-9]{6})$","type":"string"},"size":{"default":12,"maximum":96,"minimum":7,"type":"integer"},"variants":{"$ref":"#/components/schemas/FontVariants"}},"required":["color","family","size","variants"],"title":"Font","type":"object"},"CreateSignatureDateFieldFont":{"description":"Font configuration (family, size, color, style variants).","example":{"family":"Inconsolata","color":"#F53D1E","size":12,"variants":{"bold":true,"italic":false}},"nullable":true,"properties":{"family":{"$ref":"#/components/schemas/FontFamily"},"color":{"default":"#000000","pattern":"^#([a-f0-9]{6}|[A-F0-9]{6})$","type":"string"},"size":{"default":12,"maximum":96,"minimum":7,"type":"integer"},"variants":{"$ref":"#/components/schemas/FontVariants"}},"required":["color","family","size","variants"],"title":"Font","type":"object"},"UpdateFieldFont":{"description":"If set, **width** and **height** properties become required. Otherwise, if not set the font will not be changed, and if set to null the default font will be used.","example":{"family":"Inconsolata","color":"#F53D1E","size":12,"variants":{"bold":true,"italic":false}},"nullable":true,"properties":{"family":{"$ref":"#/components/schemas/FontFamily"},"color":{"default":"#000000","pattern":"^#([a-f0-9]{6}|[A-F0-9]{6})$","type":"string"},"size":{"default":12,"maximum":22,"minimum":8,"type":"integer"},"variants":{"$ref":"#/components/schemas/FontVariants"}},"required":["color","family","size","variants"],"title":"Font","type":"object"},"SmsNotification":{"properties":{"otp_message":{"$ref":"#/components/schemas/OtpMessage"}},"required":["otp_message"],"title":"SMS Notification","type":"object"},"EmailNotification":{"properties":{"disabled":{"description":"List of disabled email notifications","items":{"enum":["signer.signature_request_canceled_due_to_an_error.signer_who_has_not_signed","signer.signature_request_canceled_due_to_an_error.signer_who_has_already_signed","signer.signature_request_canceled_by_sender.signer_who_has_not_signed","signer.signature_request_canceled_by_sender.signer_who_has_already_signed","signer.signature_request_done.signature_request_contains_one_signer","signer.signature_request_done.signature_request_contains_multiple_signers","signer.signature_request_with_multiple_signers_signed.signed_by_a_signer","signer.signature_request_updated.new_expiration_date","signer.signature_request_updated_by_sender.new_signer_details","signer.signature_request_signature_requested.first_notification","signer.signature_request_signature_requested.reminder_to_sign"],"type":"string"},"title":"Disabled email notifications","type":"array"}},"required":["disabled"],"title":"Email Notification","type":"object"},"DisabledSigningContexts":{"default":[],"description":"Allows you to make Signature Requests unavailable in the contexts specified in this setting.\n","example":["inbox","signature_portal"],"items":{"enum":["inbox","signature_portal"],"type":"string"},"title":"Disabled Signing Contexts","type":"array"},"FieldsInput":{"oneOf":[{"$ref":"#/components/schemas/Signature_2"},{"$ref":"#/components/schemas/Mention_2"},{"$ref":"#/components/schemas/Text_2"},{"$ref":"#/components/schemas/Checkbox_2"},{"$ref":"#/components/schemas/RadioGroup_2"}],"type":"object"},"SignerDeliveryMode":{"description":"Override the delivery mode of the Signature Request for this Signer","enum":["email","none"],"nullable":true,"type":"string"},"SmsNotification_1":{"nullable":true,"properties":{"otp_message":{"$ref":"#/components/schemas/OTP_Message"}},"required":["otp_message"],"title":"SMS Notification","type":"object"},"EmailNotification_1":{"nullable":true,"properties":{"disabled":{"items":{"description":"If the delivery mode is \"email\" for the Signer, you can list all the emails you don't want them to receive.","enum":["signer.signature_request_canceled_due_to_an_error.signer_who_has_not_signed","signer.signature_request_canceled_due_to_an_error.signer_who_has_already_signed","signer.signature_request_canceled_by_sender.signer_who_has_not_signed","signer.signature_request_canceled_by_sender.signer_who_has_already_signed","signer.signature_request_done.signature_request_contains_one_signer","signer.signature_request_done.signature_request_contains_multiple_signers","signer.signature_request_with_multiple_signers_signed.signed_by_a_signer","signer.signature_request_updated.new_expiration_date","signer.signature_request_updated_by_sender.new_signer_details","signer.signature_request_signature_requested.first_notification","signer.signature_request_signature_requested.reminder_to_sign"],"type":"string"},"title":"Disabled Email Notification","type":"array"}},"required":["disabled"],"title":"Email Notification","type":"object"},"UserRole":{"enum":["owner","admin","member"],"title":"User Role","type":"string"},"UserStatus":{"enum":["invited","signed_up","verified","completed"],"minLength":1,"title":"User Status","type":"string"},"ManageableRole":{"enum":["admin","member"],"title":"Manageable Role","type":"string"},"WorkflowSessionApplicantId":{"description":"Unique identifier of an Applicant.\n","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","nullable":true,"title":"Applicant","type":"string"},"BankAccountStatus":{"description":"Status of the Bank Account Verification.","enum":["pending","awaiting_data","verified","failed","inconclusive"],"example":"verified","type":"string"},"IBAN":{"description":"International Bank Account Number (IBAN)","example":"FR7610278030060001478474080","maxLength":34,"minLength":14,"pattern":"^([A-Z]{2}[ \\-]?[0-9]{2})(?=(?:[ \\-]?[A-Z0-9]){9,30}$)((?:[ \\-]?[A-Z0-9]{3,5}){2,7})([ \\-]?[A-Z0-9]{1,3})?$","type":"string"},"BIC":{"description":"Business Identifier Codes (BIC)","example":"CMCIFR2A","maxLength":11,"minLength":8,"pattern":"^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$","type":"string"},"NullableIBAN":{"description":"International Bank Account Number (IBAN)","example":"FR7610278030060001478474080","maxLength":34,"minLength":14,"nullable":true,"pattern":"^([A-Z]{2}[ \\-]?[0-9]{2})(?=(?:[ \\-]?[A-Z0-9]){9,30}$)((?:[ \\-]?[A-Z0-9]{3,5}){2,7})([ \\-]?[A-Z0-9]{1,3})?$","type":"string"},"NullableBIC":{"description":"Business Identifier Codes (BIC)","example":"CMCIFR2A","maxLength":11,"minLength":8,"nullable":true,"pattern":"^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$","type":"string"},"IdentityDocumentStatus":{"description":"Status of the Identity Document Verification","enum":["pending","awaiting_data","verified","failed","inconclusive"],"example":"verified","type":"string"},"IdentityVideoStatus":{"description":"Status of the Identity Video Verification","enum":["pending","verified","failed","inconclusive"],"example":"verified","type":"string"},"IdentityVideoDocument":{"additionalProperties":false,"description":"Includes all information that has been extracted from the document, as well as the best images of the document.","nullable":true,"properties":{"full_name":{"description":"Full name of the document holder as it appears on the identity document","example":"David Vincent","maxLength":510,"nullable":true,"type":"string"},"born_on":{"description":"Date of birth on the document","example":"2024-01-18","format":"date","nullable":true,"type":"string"},"type":{"description":"Type of document.","enum":[null,"driver_license","id_card","passport","residence_permit","travel_document"],"nullable":true,"type":"string"},"issuing_country_code":{"example":"US","format":"ISO 3166-1 alpha-2","nullable":true,"pattern":"^[A-Z]{2}$","type":"string"},"national_identification_number":{"description":"Some documents may contain a national identification number.\nFor example, Italian ID cards contain the Codice Fiscale on the back of the document.\nWhen this data is available on the document, it will be returned here, otherwise it will be NULL.\nConsult our [guide](https://developers.youtrust.com/docs/video-based-identity-verification) for more details and examples.\n","example":"MLLSNT82P65Z404U","nullable":true,"type":"string"}},"required":["born_on","full_name","issuing_country_code","national_identification_number","type"],"title":"IdentityVideoDocument","type":"object"},"WatchlistStatus":{"description":"Status of the Watchlist Verification.","enum":["pending","verified","failed","inconclusive"],"example":"verified","type":"string"},"WebhookWildcardSubscribedEvent":{"deprecated":true,"description":"Allows you to subscribe to all events currently existing.","items":{"enum":["*"],"type":"string"},"title":"All Events","type":"array"},"WebhookSubscribedEvents":{"description":"List of specific webhook events to subscribe to.","items":{"enum":["document_analysis.done","signer.notified","signer.declined","signer.done","signer.link_opened","signer.identification_failed","signer.identification_succeeded","signer.identification_blocked","signer.identification_expired","signer.identity_saved","signer.sender_contacted","signer.error","signer.notification_delivery_failed","signature_request.activated","signature_request.declined","signature_request.canceled","signature_request.done","signature_request.expired","signature_request.reminder_executed","signature_request.automatic_reminder_executed","signature_request.approved","signature_request.deleted","signature_request.permanently_deleted","signature_request.reactivated","signature_request.rejected","signature_request.paused","signature_request.resumed","contact.created","approver.notified","approver.approved","approver.rejected","approver.notification_delivery_failed","electronic_seal.done","electronic_seal.error","user.completed","verification.identity_video.done","verification.bank_account.done","verification.bank_account_connection.done","verification.bank_account_lookup.done","verification.identity_document.done","verification.company.done","verification.watchlist.done","verification.proof_of_address.done","monitoring.natural_person.activated","monitoring.natural_person.inconclusive","monitoring.natural_person.canceled","monitoring.natural_person.updated","workflow_action_group.started","workflow_action_group.blocked","workflow_action_group.done","workflow_session.started","workflow_session.blocked","workflow_session.done","applicant.notified","applicant.processed","applicant.session_blocked"],"type":"string"},"title":"Specific Webhook Events","type":"array"},"WebhookWildcardScope":{"description":"Wildcard scope to subscribe to all scopes.","items":{"enum":["*"],"type":"string"},"title":"All Scopes","type":"array"},"WebhookScopes":{"description":"One or multiple specific scopes to subscribe.","items":{"enum":["app","public_api","connector_zapier_api"],"type":"string"},"title":"Specific Scopes","type":"array"},"WebhookWildcardWorkspace":{"description":"Allows you to select all Workspaces.","items":{"enum":["*"],"type":"string"},"title":"All Workspaces","type":"array"},"WebhookWorkspaces":{"description":"List of Workspace UUIDs.","items":{"$ref":"#/components/schemas/UUID"},"title":"Workspace UUIDs","type":"array"},"WorkflowSessionActionResource":{"description":"The resource associated with this Action.","example":{"id":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","created_at":"2025-02-12T23:59:59+00:00","type":"identity_video_verification","status":"verified","previous_attempt_id":null},"properties":{"id":{"description":"Unique identifier of the Action. Corresponds to the ID of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"created_at":{"description":"Creation date of the Action Resource.","example":"2025-02-12T23:59:59Z","format":"date-time","type":"string"},"type":{"description":"Type of the Action.","enum":["signature_request","identity_document_verification","identity_video_verification","proof_of_address_verification","company_verification","watchlist_verification","bank_account_verification","bank_account_connection_verification","bank_account_lookup_verification","social_security_document_analysis","company_certificate_document_analysis","business_registration_certificate_document_analysis","driver_licence_document_analysis","rne_certificate_document_analysis","temporary_vehicle_registration_document_analysis","vehicle_registration_document_analysis","auto_insurance_claims_history_document_analysis","payslip_document_analysis","invoice_document_analysis","id_document_document_analysis"],"example":"identity_document_verification","type":"string"},"status":{"description":"Status of the Action. Corresponds to the status of the resources associated with this Workflow Session (Signature Request, Identity Document Verification, etc.).","example":"verified","type":"string"},"previous_attempt_id":{"description":"ID of the previous attempt if this Action is a retry.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","nullable":true,"type":"string"}},"required":["created_at","id","previous_attempt_id","status","type"],"title":"Workflow Session Action Resource","type":"object"},"CreateWorkflowSessionApplicantNaturalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"label":{"description":"Label of the Applicant.","example":"John Doe","maxLength":255,"minLength":1,"type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"type":{"description":"Type of the Applicant.","enum":["natural_person"],"type":"string"},"natural_person":{"$ref":"#/components/schemas/CreateNaturalPerson"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session). Can be changed until the first magic link has been generated for the Workflow Session; once a link exists the parent is immutable and any attempt to change it returns a 400 error.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"required":["label","type"],"title":"Create Natural Person Applicant","type":"object"},"CreateWorkflowSessionApplicantLegalPerson":{"additionalProperties":false,"description":"Create a legal person Applicant.","properties":{"label":{"description":"Label of the Applicant.","example":"Acme Corp","maxLength":255,"minLength":1,"type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"type":{"description":"Type of the Applicant.","enum":["legal_person"],"type":"string"},"legal_person":{"$ref":"#/components/schemas/CreateLegalPerson"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session). Can be changed until the first magic link has been generated for the Workflow Session; once a link exists the parent is immutable and any attempt to change it returns a 400 error.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"}},"required":["label","type"],"title":"Create Legal Person Applicant","type":"object"},"NaturalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"identity":{"allOf":[{"$ref":"#/components/schemas/Identity"}],"description":"Identity of the natural person.","nullable":true,"type":"object"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Postal address of the natural person.","nullable":true,"type":"object"},"bank_account":{"allOf":[{"$ref":"#/components/schemas/BankAccount"}],"description":"Bank account of the natural person.","nullable":true,"type":"object"}},"required":["address","bank_account","identity"],"type":"object"},"LegalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"company_name":{"description":"Name of the company.","example":"Acme","nullable":true,"type":"string"},"country_code":{"description":"Country code of the company (ISO 3166-1 alpha-2).","example":"FR","nullable":true,"type":"string"},"bank_account":{"allOf":[{"$ref":"#/components/schemas/BankAccount"}],"description":"Bank account of the legal person.","nullable":true,"type":"object"},"legal_representatives":{"description":"Legal representatives of the company.","items":{"$ref":"#/components/schemas/Identity"},"type":"array"}},"required":["bank_account","company_name","country_code","legal_representatives"],"type":"object"},"UpdateNaturalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"identity":{"$ref":"#/components/schemas/Identity"},"address":{"$ref":"#/components/schemas/Address"},"bank_account":{"$ref":"#/components/schemas/BankAccount"}},"title":"Natural Person","type":"object"},"UpdateLegalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"company_name":{"description":"Name of the company.","example":"Acme","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"country_code":{"description":"Country code of the company (ISO 3166-1 alpha-2).","enum":["FR",null],"example":"FR","nullable":true,"type":"string"},"bank_account":{"$ref":"#/components/schemas/BankAccount"},"legal_representatives":{"description":"Legal representatives of the company.","items":{"$ref":"#/components/schemas/Identity"},"type":"array"}},"title":"Legal Person","type":"object"},"AnalysisTypeMultipart":{"additionalProperties":false,"description":"Same as `analysis_type` on the JSON path, but sent as `multipart/form-data`.\nBecause form-data has no native boolean, `extraction` is a string (`\"true\"`/`\"false\"`).\n\n- When `extraction` is `\"true\"` (default), data is extracted from the document and a document `type` is **required**.\n- When `extraction` is `\"false\"` (fraud-only), no `type` must be provided and `fraud_level` must be `advanced`.\n","properties":{"extraction":{"default":"true","description":"Whether to extract data from the document. Defaults to `\"true\"` when omitted.\nSet to `\"false\"` to run a fraud-only analysis (no data extraction).\n","enum":["true","false"],"example":"true","type":"string"},"fraud_level":{"description":"Level of fraud detection to run. `null` (default) disables fraud detection.\nNot supported for type `tax_notice`. Must be `advanced` when `extraction` is `\"false\"`.\n","enum":["none","standard","advanced"],"example":"advanced","nullable":true,"type":"string"}},"title":"AnalysisType","type":"object"},"DocumentAnalysisCheck":{"additionalProperties":false,"description":"Represents the result of checking if an extracted value matches an expected value with different levels of match (exact, close, or no match).","example":{"extracted":"John Doe","expected":"John Doe","match_level":"exact"},"properties":{"extracted":{"description":"The extracted value from the document.","nullable":true,"type":"string"},"expected":{"description":"The expected value for the check.","type":"string"},"match_level":{"$ref":"#/components/schemas/DocumentAnalysisMatchLevel"}},"required":["expected","extracted","match_level"],"title":"Document Analysis Check","type":"object"},"DocumentAnalysisMatchLevel":{"description":"Level of match between extracted and expected value.","enum":["exact","close","no_match"],"example":"exact","title":"MatchLevel","type":"string"},"SignatureRequest_EmailNotification_Sender":{"properties":{"type":{"description":"Identity used as the email sender.","enum":["organization","workspace","custom","user"],"type":"string"},"custom_name":{"description":"To use in association with sender type custom to precise the name.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","format":"safe-string","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"title":"SignatureRequest_Sender","type":"object"},"FontFamily":{"enum":["Inconsolata","Open Sans","Lato","Raleway","Merriweather","EB Garamond","Comic Neue","Monaco","Helvetica","Courier","Times Roman"],"title":"FontFamily","type":"string"},"FontVariants":{"properties":{"italic":{"default":false,"type":"boolean"},"bold":{"default":false,"type":"boolean"}},"required":["bold","italic"],"title":"FontVariants","type":"object"},"OtpMessage":{"properties":{"custom_text":{"description":"Custom text contained is the one-time password SMS sent to the Signer. This feature is available from SCALE plan, and disabled by default. Please contact [customer support](https://yousign.app/auth/workspace/help) to request an activation.","minLength":1,"nullable":true,"type":"string"}},"required":["custom_text"],"title":"OTP Message","type":"object"},"CreateNaturalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"identity":{"$ref":"#/components/schemas/Identity"},"address":{"$ref":"#/components/schemas/Address"},"bank_account":{"$ref":"#/components/schemas/BankAccount"}},"title":"Natural Person","type":"object"},"CreateLegalPerson":{"additionalProperties":false,"description":"Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.","properties":{"company_name":{"description":"Name of the company.","example":"Acme","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"country_code":{"description":"Country code of the company (ISO 3166-1 alpha-2).","enum":["FR"],"example":"FR","nullable":true,"type":"string"},"bank_account":{"$ref":"#/components/schemas/BankAccount"},"legal_representatives":{"description":"Legal representatives of the company.","items":{"$ref":"#/components/schemas/Identity"},"type":"array"}},"title":"Legal Person","type":"object"},"Identity":{"additionalProperties":false,"description":"Describes the Applicant.","properties":{"first_name":{"description":"First name of the person.","example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"description":"Last name of the person.","example":"Doe","maxLength":255,"minLength":1,"type":"string"}},"required":["first_name","last_name"],"title":"Identity","type":"object"},"Address":{"additionalProperties":false,"description":"Provide the Applicants full address.","properties":{"line1":{"description":"The first line of the address, typically the street name and number.","example":"1 rue de la Paix","maxLength":500,"minLength":1,"type":"string"},"line2":{"description":"If needed, the second line of the address, typically an apartment or suite number.","maxLength":500,"minLength":1,"nullable":true,"type":"string","example":null},"postal_code":{"description":"The postal code of the address.","example":"75002","maxLength":10,"minLength":1,"type":"string"},"city":{"description":"The city of the address.","example":"Paris","maxLength":200,"minLength":1,"type":"string"}},"required":["city","line1","postal_code"],"title":"Address","type":"object"},"BankAccount":{"additionalProperties":false,"description":"Bank account details.","nullable":true,"properties":{"iban":{"description":"International Bank Account Number.","example":"FR7630001007941234567890185","minLength":1,"type":"string"},"bic":{"description":"Business Identifier Code.","example":"BDFEFR2L","nullable":true,"type":"string"}},"required":["iban"],"title":"Bank Account","type":"object"},"BadRequestResponse":{"properties":{"type":{"type":"string"},"detail":{"type":"string"}},"required":["detail","type"],"title":"BadRequestResponse","type":"object"},"UnauthorizedResponse":{"properties":{"type":{"type":"string"},"detail":{"type":"string"}},"required":["detail","type"],"title":"UnauthorizedResponse","type":"object"},"ForbiddenResponse":{"properties":{"type":{"type":"string"},"detail":{"type":"string"}},"required":["detail","type"],"title":"ForbiddenResponse","type":"object"},"NotFoundResponse":{"properties":{"type":{"type":"string"},"detail":{"type":"string"}},"required":["detail","type"],"title":"NotFoundResponse","type":"object"},"MethodNotAllowed":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"MethodNotAllowed","type":"object"},"UnsupportedMediaTypeResponse":{"properties":{"type":{"type":"string"},"detail":{"type":"string"}},"required":["detail","type"],"title":"UnsupportedMediaTypeResponse","type":"object"},"TooManyRequestsResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"TooManyRequestsResponse","type":"object"},"InternalServerError":{"properties":{"type":{"example":"about:blank","type":"string"},"detail":{"example":"Something wrong occurred.","type":"string"}},"required":["detail","type"],"title":"InternalServerError","type":"object"},"get_consumption_addon_200_response":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AddonConsumption"},"type":"array"}},"required":["data"],"type":"object"},"get_consumption_detail_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/PaginationWithUpdatedAt"},"data":{"items":{"$ref":"#/components/schemas/DetailedConsumption"},"type":"array"}},"type":"object"},"get_consumptions_records_electronic_seals_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/ElectronicSealsConsumption"},"type":"array"}},"required":["data","meta"],"type":"object"},"get_consumptions_records_identifications_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/IdentificationsConsumption"},"type":"array"}},"required":["data","meta"],"type":"object"},"get_consumptions_records_invited_signers_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/InvitedSignersConsumption"},"type":"array"}},"required":["data","meta"],"type":"object"},"get_contacts_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}},"type":"object"},"get_custom_experiences_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/CustomExperience"},"type":"array"}},"type":"object"},"patch_custom_experience_logo_request":{"description":"Upload a file","properties":{"file":{"example":"Binary file","format":"binary","type":"string"}},"required":["file"],"type":"object"},"get_document_analyses_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/DocumentAnalysisMeta"},"type":"array"}},"type":"object"},"post_document_analyses_201_response":{"oneOf":[{"$ref":"#/components/schemas/SocialSecurityFull"},{"$ref":"#/components/schemas/CompanyCertificateFull"},{"$ref":"#/components/schemas/BusinessRegistrationCertificateFull"},{"$ref":"#/components/schemas/DriverLicenceFull"},{"$ref":"#/components/schemas/RNECertificateFull"},{"$ref":"#/components/schemas/TemporaryVehicleRegistrationDocumentFull"},{"$ref":"#/components/schemas/VehicleRegistrationDocumentFull"},{"$ref":"#/components/schemas/AutoInsuranceClaimsHistoryFull"},{"$ref":"#/components/schemas/TaxNoticeFull"},{"$ref":"#/components/schemas/PayslipFull"},{"$ref":"#/components/schemas/InvoiceFull"},{"$ref":"#/components/schemas/ProofOfAddressFull"},{"$ref":"#/components/schemas/IdDocumentFull"},{"$ref":"#/components/schemas/FraudOnlyFull"}]},"list_electronic_seal_images_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/ElectronicSealImage"},"type":"array"}},"type":"object"},"get_labels_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/Label"},"type":"array"}},"type":"object"},"get_signature_requests_200_response":{"properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Pagination metadata for the response."},"data":{"description":"List of Signature Requests matching the query.","items":{"$ref":"#/components/schemas/SignatureRequestInList"},"type":"array"}},"type":"object"},"post_signature_requests_signatureRequestId_cancel_request":{"properties":{"reason":{"description":"Reason for cancelling the Signature Request.","enum":["contractualization_aborted","errors_in_document","other"],"type":"string"},"custom_note":{"description":"Free-text note detailing the cancellation reason.","format":"safe-string","maxLength":500,"nullable":true,"type":"string"}},"required":["reason"],"type":"object"},"post_signature_requests_signatureRequestId_cancel_201_response":{"allOf":[{"$ref":"#/components/schemas/SignatureRequest"},{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/SignatureRequestStatus"}],"description":"Current status of the Signature Request (`canceled` after this call)."}},"type":"object"}]},"get_signature_requests_signatureRequestId_signer_consent_requests_200_response":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SignerConsentRequest"},"type":"array"}},"type":"object"},"get_signature_requests_signatureRequestId_signer_document_requests_200_response":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SignerDocumentRequest"},"type":"array"}},"type":"object"},"get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner":{"oneOf":[{"$ref":"#/components/schemas/FieldSignature"},{"$ref":"#/components/schemas/FieldText"},{"$ref":"#/components/schemas/FieldMention"},{"$ref":"#/components/schemas/FieldCheckbox"},{"$ref":"#/components/schemas/FieldRadioButtonGroup"},{"$ref":"#/components/schemas/FieldReadOnlyText"},{"$ref":"#/components/schemas/FieldSignatureDate"},{"$ref":"#/components/schemas/FieldSignerName"},{"$ref":"#/components/schemas/FieldSignerEmail"}]},"get_signature_requests_signatureRequestId_documents_documentId_fields_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/get_signature_requests_signatureRequestId_documents_documentId_fields_200_response_data_inner"},"type":"array"}},"type":"object"},"post_signature_requests_signatureRequestId_documents_documentId_replace_request":{"properties":{"file":{"description":"Accepted formats: PDF, DOCX, JPEG, JPG and PNG. All files are converted to PDF upon upload.\nIf the Document nature is signable_document, only PDF or DOCX file formats are allowed.\n","format":"binary","type":"string"},"name":{"description":"The document name. If not set, will use the uploaded document name. This value should contain any characters except \"\\\", \"/\" and can\\'t start and finish with a space.","example":"file1","maxLength":128,"minLength":1,"pattern":"^(?!\\s)[^\\/\\\\]+(?<!\\s)$","type":"string"}},"required":["file"],"type":"object"},"get_signature_requests_signatureRequestId_followers_200_response":{"description":"A list of Followers added to the Signature Request.","properties":{"data":{"items":{"$ref":"#/components/schemas/Follower"},"type":"array"}},"type":"object"},"get_signature_requests_id_labels_200_response":{"properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Pagination metadata for the response."},"data":{"description":"List of Labels associated with the Signature Request.","items":{"$ref":"#/components/schemas/SignatureRequestLabel"},"type":"array"}},"type":"object"},"post_signature_requests_id_pause_201_response":{"allOf":[{"$ref":"#/components/schemas/SignatureRequest"},{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/SignatureRequestStatus"}],"description":"Current status of the Signature Request (`paused` after this call)."}},"type":"object"}]},"post_signature_requests_signatureRequestId_reactivate_request":{"properties":{"expiration_date":{"description":"Due date of the Signature Request (yyyy-mm-dd).\nThe date cannot be in the past and cannot be more than one year after initiation.\n","format":"date","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"}},"required":["expiration_date"],"type":"object"},"post_signature_requests_id_resume_201_response":{"allOf":[{"$ref":"#/components/schemas/SignatureRequest"},{"properties":{"status":{"allOf":[{"$ref":"#/components/schemas/SignatureRequestStatus"}],"description":"Current status of the Signature Request (`ongoing` or `approval` after this call)."}},"type":"object"}]},"get_signature_requests_signatureRequestId_signers_signerId_documents_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/SignerDocument"},"type":"array"}},"type":"object"},"get_templates_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/Template"},"type":"array"}},"type":"object"},"get_users_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}},"required":["data","meta"],"type":"object"},"get_invitations_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/UserInvitation"},"type":"array"}},"type":"object"},"get_verifications_bank_account_lookups_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/BankAccountLookupMeta"},"type":"array"}},"type":"object"},"post_verifications_bank_account_lookups_request":{"oneOf":[{"$ref":"#/components/schemas/InitiateBankAccountLookupWithNaturalPerson"},{"$ref":"#/components/schemas/InitiateBankAccountLookupFromApplicant"}]},"get_verifications_bank_accounts_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/BankAccountMeta"},"type":"array"}},"type":"object"},"post_verifications_bank_accounts_request":{"anyOf":[{"$ref":"#/components/schemas/InitiateBankAccount"},{"$ref":"#/components/schemas/InitiateBankAccountWithLegalPerson"},{"$ref":"#/components/schemas/InitiateBankAccountWithNaturalPerson"}],"type":"object"},"get_verifications_companies_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/CompanyMeta"},"type":"array"}},"type":"object"},"post_verifications_companies_request":{"oneOf":[{"$ref":"#/components/schemas/InitiateCompanyFromJson"},{"$ref":"#/components/schemas/InitiateCompanyFromApplicant"}]},"get_verifications_identity_documents_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/IdentityDocumentMeta"},"type":"array"}},"type":"object"},"post_verifications_identity_documents_request":{"anyOf":[{"$ref":"#/components/schemas/InitiateIdentityDocument"},{"$ref":"#/components/schemas/InitiateIdentityDocumentWithoutName"}],"type":"object"},"get_verifications_identity_videos_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/IdentityVideoMeta"},"type":"array"}},"type":"object"},"get_verifications_proofs_of_address_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/ProofOfAddressMeta"},"type":"array"}},"type":"object"},"get_verifications_watchlists_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/WatchlistMeta"},"type":"array"}},"type":"object"},"get_workflow_sessions_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/WorkflowSession"},"type":"array"}},"type":"object"},"get_workflow_sessions_id_applicants_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/WorkflowSessionApplicantListItem"},"type":"array"}},"type":"object"},"get_workflow_templates_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/WorkflowTemplate"},"type":"array"}},"type":"object"},"get_workspaces_200_response":{"properties":{"meta":{"$ref":"#/components/schemas/Pagination"},"data":{"items":{"$ref":"#/components/schemas/Workspace"},"type":"array"}},"type":"object"},"Consumption_app_qualified_electronic_signature_identification_mode_identity_verification":{"properties":{"succeeded":{"minimum":0,"type":"integer"},"rejected":{"minimum":0,"type":"integer"},"expired_after_succeeded":{"minimum":0,"type":"integer"}},"required":["expired_after_succeeded","rejected","succeeded"],"type":"object"},"Consumption_app_qualified_electronic_signature_identification_mode":{"properties":{"identity_verification":{"$ref":"#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode_identity_verification"},"saved_identity":{"minimum":0,"type":"integer"}},"required":["identity_verification","saved_identity"],"type":"object"},"Consumption_app":{"properties":{"electronic_signature":{"minimum":0,"type":"integer"},"advanced_electronic_signature":{"minimum":0,"type":"integer"},"advanced_electronic_signature_with_qualified_certificate":{"minimum":0,"type":"integer"},"qualified_electronic_signature_identification_mode":{"$ref":"#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode"}},"required":["advanced_electronic_signature","advanced_electronic_signature_with_qualified_certificate","electronic_signature","qualified_electronic_signature_identification_mode"],"type":"object"},"Consumption_api":{"properties":{"electronic_signature":{"minimum":0,"type":"integer"},"advanced_electronic_signature":{"minimum":0,"type":"integer"},"advanced_electronic_signature_with_qualified_certificate":{"minimum":0,"type":"integer"},"electronic_seal":{"minimum":0,"type":"integer"},"advanced_electronic_seal":{"minimum":0,"type":"integer"},"qualified_electronic_signature_identification_mode":{"$ref":"#/components/schemas/Consumption_app_qualified_electronic_signature_identification_mode"}},"required":["advanced_electronic_signature","advanced_electronic_signature_with_qualified_certificate","electronic_signature","qualified_electronic_signature_identification_mode"],"type":"object"},"CustomExperience_redirect_urls":{"properties":{"success":{"example":"https://example.com/success","format":"uri","nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","nullable":true,"type":"string"}},"required":["decline","error","success"],"type":"object"},"CustomExperience_embedded_preparation_navigation_bar":{"description":"Navigation bar of the Embedded Preparation page, or null when it is not displayed at all.","nullable":true,"properties":{"done_button":{"description":"If true, the `Done` button is displayed in the navigation bar.","type":"boolean"},"back_button":{"description":"If true, the `Back` button is displayed in the navigation bar.","type":"boolean"}},"required":["back_button","done_button"],"type":"object"},"CreateCustomExperience_redirect_urls":{"nullable":true,"properties":{"success":{"example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"UpdateCustomExperience_redirect_urls":{"nullable":true,"properties":{"success":{"example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"required":["decline","error","success"],"type":"object"},"InitiateDocumentAnalysisFromApplicant_checks_income_year_check":{"additionalProperties":false,"description":"Expected income year to check against the document.","properties":{"income_year":{"description":"The expected income year to check against the tax notice document.","example":2024,"type":"integer"}},"required":["income_year"],"type":"object"},"InitiateDocumentAnalysisFromApplicant_checks":{"additionalProperties":false,"description":"Checks to perform on the document.\nOnly accepted when `type` is `tax_notice`.\n","nullable":true,"properties":{"income_year_check":{"$ref":"#/components/schemas/InitiateDocumentAnalysisFromApplicant_checks_income_year_check"}},"type":"object"},"French_Vehicle_Registration_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["vehicle_registration_document"],"type":"string"},"country_code":{"enum":["FR"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/FrenchVehicleRegistrationDocumentExtraction"},"checks":{"$ref":"#/components/schemas/VehicleRegistrationDocumentCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"French Vehicle Registration Document","type":"object"},"Italian_Vehicle_Registration_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["vehicle_registration_document"],"type":"string"},"country_code":{"enum":["IT"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/ItalianVehicleRegistrationDocumentExtraction"},"checks":{"$ref":"#/components/schemas/VehicleRegistrationDocumentCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Italian Vehicle Registration Document","type":"object"},"French_Tax_Notice_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["tax_notice"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/FrenchTaxNoticeExtraction"},"checks":{"$ref":"#/components/schemas/TaxNoticeCheck"}},"type":"object"}],"required":["checks","extracted_from_document","type"],"title":"French Tax Notice Document","type":"object"},"German_Tax_Notice_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["tax_notice"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/GermanTaxNoticeExtraction"},"checks":{"$ref":"#/components/schemas/TaxNoticeCheck"}},"type":"object"}],"required":["checks","extracted_from_document","type"],"title":"German Tax Notice Document","type":"object"},"Italian_Tax_Notice":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["tax_notice"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/ItalianTaxNoticeExtraction"},"checks":{"$ref":"#/components/schemas/TaxNoticeCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Italian Tax Notice","type":"object"},"French_Invoice_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["invoice"],"type":"string"},"country_code":{"description":"The country code associated with the document analysis.","enum":["FR"],"example":"FR","type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/FrenchInvoiceExtraction"},"checks":{"$ref":"#/components/schemas/InvoiceCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"French Invoice Document","type":"object"},"Italian_Invoice_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["invoice"],"type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/ItalianInvoiceExtraction"},"checks":{"$ref":"#/components/schemas/InvoiceCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Italian Invoice Document","type":"object"},"German_Invoice_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["invoice"],"type":"string"},"country_code":{"description":"The country code associated with the document analysis.","enum":["DE"],"example":"DE","type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/GermanInvoiceExtraction"},"checks":{"$ref":"#/components/schemas/InvoiceCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"German Invoice Document","type":"object"},"Italian_Proof_of_Address_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["proof_of_address"],"type":"string"},"country_code":{"description":"The country code associated with the document analysis.","enum":["IT"],"example":"IT","type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/ItalianProofOfAddressExtraction"},"checks":{"$ref":"#/components/schemas/ProofOfAddressCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"Italian Proof of Address Document","type":"object"},"German_Proof_of_Address_Document":{"allOf":[{"$ref":"#/components/schemas/DocumentAnalysisMeta_1"},{"properties":{"type":{"enum":["proof_of_address"],"type":"string"},"country_code":{"description":"The country code associated with the document analysis.","enum":["DE"],"example":"DE","type":"string"},"extracted_from_document":{"$ref":"#/components/schemas/GermanProofOfAddressExtraction"},"checks":{"$ref":"#/components/schemas/ProofOfAddressCheck"}},"type":"object"}],"required":["checks","country_code","created_at","data_anonymized","extracted_from_document","id","previous_attempt_id","status","type","updated_at","workflow_session_id","workspace_id"],"title":"German Proof of Address Document","type":"object"},"FraudOnlyFull_allOf_analysis_type":{"properties":{"extraction":{"description":"Always `false` for a fraud-only analysis.","example":false,"type":"boolean"},"fraud_level":{"description":"Always `advanced` for a fraud-only analysis.","enum":["advanced"],"example":"advanced","type":"string"}},"required":["extraction","fraud_level"],"type":"object"},"Document_initials_per_page_inner":{"properties":{"page":{"description":"Page number.","minimum":1,"type":"integer"},"y":{"description":"Y-axis position of the initials on the page.","minimum":0,"type":"integer"}},"required":["page","y"],"type":"object"},"Document_initials":{"nullable":true,"properties":{"alignment":{"description":"Alignment of the initials on the document’s pages.","enum":["left","center","right"],"type":"string"},"y":{"description":"Y-axis position of the initials on the first page of the document.","minimum":0,"type":"integer"},"per_page":{"items":{"$ref":"#/components/schemas/Document_initials_per_page_inner"},"type":"array"}},"required":["alignment","per_page","y"],"type":"object"},"From_Electronic_Seal_Document":{"description":"Create an Electronic Seal Document from a previously sealed document.","properties":{"electronic_seal_document_id":{"description":"Id of the Electronic Seal Document. The Electronic Seal must be done to use its Electronic Seal Document.","example":"672a5a0b-ac65-407e-9da9-d34402bae974","format":"uuid","type":"string"}},"required":["electronic_seal_document_id"],"title":"From Electronic Seal Document","type":"object"},"From_Signature_Request_Document":{"description":"Create an Electronic Seal Document from a Signature Request Document already signed.","properties":{"signature_request_document_id":{"description":"Id of the Signature Request Document, the Signature Request must be Done.","example":"672a5a0b-ac65-407e-9da9-d34402bae974","format":"uuid","type":"string"}},"required":["signature_request_document_id"],"title":"From Signature Request Document","type":"object"},"CreateElectronicSealImagePreviewPayload_field_captions_inner":{"additionalProperties":false,"properties":{"text":{"description":"The caption text to display on the seal image.","example":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","maxLength":150,"type":"string"}},"required":["text"],"type":"object"},"CreateElectronicSealImagePreviewPayload_field":{"additionalProperties":false,"description":"The seal field dimensions and optional caption.","properties":{"width":{"description":"Width of the seal field in pixels.","example":150,"maximum":32767,"minimum":1,"type":"integer"},"height":{"description":"Height of the seal field in pixels.","example":100,"maximum":32767,"minimum":1,"type":"integer"},"captions":{"description":"Optional captions to display on the seal image. Limited to one caption per field.","items":{"$ref":"#/components/schemas/CreateElectronicSealImagePreviewPayload_field_captions_inner"},"maxItems":1,"nullable":true,"type":"array"}},"required":["height","width"],"type":"object"},"CreateElectronicSealPayload_fields_inner":{"anyOf":[{"$ref":"#/components/schemas/CreateElectronicSealFieldSealPayload"},{"$ref":"#/components/schemas/CreateElectronicSealFieldReadOnlyTextPayload"}],"type":"object"},"SignatureRequestInList_reminder_settings":{"description":"Automatic reminder configuration for pending recipients; `null` if reminders are disabled.","nullable":true,"properties":{"interval_in_days":{"description":"Number of days between two reminders.","enum":[1,2,7,14],"format":"int32","type":"integer"},"max_occurrences":{"description":"Maximum number of reminders sent.","format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["interval_in_days","max_occurrences"],"type":"object"},"SignatureRequestInList_signers_inner":{"properties":{"id":{"description":"Unique identifier of the Signer.","type":"string"},"status":{"description":"Current status of the Signer.","enum":["initiated","declined","notified","verified","processing","consent_given","signed","aborted","error"],"type":"string"}},"required":["id","status"],"type":"object"},"SignatureRequestInList_approvers_inner":{"properties":{"id":{"description":"Unique identifier of the Approver.","type":"string"},"status":{"description":"Current status of the Approver.","enum":["initiated","notified","approved","rejected"],"type":"string"}},"required":["id","status"],"type":"object"},"SignatureRequestInList_documents_inner":{"properties":{"id":{"description":"Unique identifier of the Document.","type":"string"},"nature":{"description":"Nature of the Document.","enum":["attachment","signable_document"],"type":"string"}},"required":["id","nature"],"type":"object"},"SignatureRequestInList_sender":{"description":"User who sent the Signature Request; `null` while in `draft`.","nullable":true,"properties":{"id":{"description":"Unique identifier of the sender.","type":"string"},"email":{"description":"Email address of the sender.","type":"string"}},"type":"object"},"New_Signature_Request_From_Scratch_reminder_settings":{"additionalProperties":false,"description":"Enable automatic reminders for pending Signers.","nullable":true,"properties":{"interval_in_days":{"description":"Number of days between two reminders.","enum":[1,2,7,14],"format":"int32","type":"integer"},"max_occurrences":{"description":"Maximum number of reminders sent.","example":5,"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["interval_in_days","max_occurrences"],"type":"object"},"New_Signature_Request_From_Scratch_signers_inner":{"anyOf":[{"$ref":"#/components/schemas/SignatureRequest_SignerFromInfoInput"},{"$ref":"#/components/schemas/SignatureRequest_SignerFromUserIdInput"},{"$ref":"#/components/schemas/SignatureRequest_SignerFromContactIdInput"}],"description":"Create signers"},"New_Signature_Request_From_Scratch_template_placeholders_signers_inner":{"anyOf":[{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromInfoInput"},{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput"},{"$ref":"#/components/schemas/SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput"}]},"New_Signature_Request_From_Scratch_template_placeholders":{"additionalProperties":false,"description":"When creating a signature request from a template, all substituting data for placeholders defined in the given template.","nullable":true,"properties":{"signers":{"description":"Substituting data for placeholder signers.","items":{"$ref":"#/components/schemas/New_Signature_Request_From_Scratch_template_placeholders_signers_inner"},"maxItems":100,"type":"array"},"read_only_text_fields":{"description":"Substituting data for placeholder read_only_text fields.","items":{"$ref":"#/components/schemas/SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput"},"maxItems":500,"type":"array"}},"type":"object"},"New_Signature_Request_From_Scratch":{"description":"Create a new Signature Request from scratch","properties":{"name":{"description":"Name of the signature request.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","format":"safe-string","maxLength":128,"minLength":1,"type":"string"},"delivery_mode":{"description":"Delivery mode to notify Signers.","enum":["none","email"],"type":"string"},"ordered_signers":{"description":"Enable an ordered workflow, each Signer will be requested to sign in a sequential order","example":true,"type":"boolean"},"ordered_approvers":{"description":"When enabled, Approvers are requested to approve sequentially.\nEach Approver will be invited to approve only once the previous one has completed their approval.\n","example":true,"type":"boolean"},"custom_recipient_order":{"description":"When enabled, Approvers and Signers are requested to approve depending of a sequence composed of stages.\nEvery recipients present in a stage will be invited to approve or sign parallelly, and stages are sequential each other.\nWhen `custom_recipient_order` is enabled, `ordered_approvers` and `ordered_signers` are ignored.\n","example":true,"type":"boolean"},"reminder_settings":{"$ref":"#/components/schemas/New_Signature_Request_From_Scratch_reminder_settings"},"timezone":{"$ref":"#/components/schemas/SignatureRequestTimeZone"},"email_custom_note":{"deprecated":true,"description":"Deprecated; use `email_notification.custom_text` instead.","example":"Please sign these documents as soon as possible.","format":"safe-string","maxLength":500,"nullable":true,"type":"string"},"expiration_date":{"description":"Due date of the Signature Request (yyyy-mm-dd). Defaults to 6 months after initiation.\nThe date cannot be in the past and cannot be more than one year after initiation.\n","format":"date","pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"template_id":{"description":"Create a Signature Request from an existing template.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"external_id":{"description":"Store a custom id that will be added to webhooks & appended to redirect urls.","maxLength":255,"nullable":true,"pattern":"^[\\w\\-@.%+]+$","type":"string"},"branding_id":{"deprecated":true,"description":"Deprecated; use `custom_experience_id` instead.","example":"3a93d3b5-fb3b-4abf-9e70-26315b33506b","format":"uuid","nullable":true,"type":"string"},"custom_experience_id":{"description":"Use a specific Custom Experience to customize the signature experience.","example":"3a93d3b5-fb3b-4abf-9e70-26315b33506b","format":"uuid","nullable":true,"type":"string"},"documents":{"deprecated":true,"description":"Deprecated; attach Documents via the Documents endpoint instead.","items":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","type":"string"},"maxItems":5,"type":"array","uniqueItems":true},"signers":{"deprecated":true,"description":"Deprecated; add Signers via the Signers endpoint instead.","items":{"$ref":"#/components/schemas/New_Signature_Request_From_Scratch_signers_inner"},"type":"array"},"workspace_id":{"description":"Scope the signature request to a specific workspace. If template_id is filled and Template is already linked to a Workspace, keep this field to null ; the created Signature Request will be scoped to Template's Workspace.","example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","nullable":true,"type":"string"},"audit_trail_locale":{"allOf":[{"$ref":"#/components/schemas/AuditTrailLocale"}],"description":"Define the locale for the generated audit trail.","nullable":true,"type":"string"},"signers_allowed_to_decline":{"default":false,"description":"Allowing signers to decline to sign.","example":true,"type":"boolean"},"email_notification":{"$ref":"#/components/schemas/SignatureRequest_EmailNotification"},"embedded_preparation":{"$ref":"#/components/schemas/SignatureRequest_EmbeddedPreparation"},"template_placeholders":{"$ref":"#/components/schemas/New_Signature_Request_From_Scratch_template_placeholders"},"archiving":{"$ref":"#/components/schemas/Archiving"},"labels":{"description":"List of Labels to associate with the Signature Request. Labels are identified by their ID.","example":["3a93d3b5-fb3b-4abf-9e70-26315b33506b","89120884-d29a-4b1a-ac7b-a9e73a872795"],"items":{"format":"uuid","type":"string"},"maxItems":50,"type":"array"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"}},"required":["delivery_mode","name"],"title":"New Signature Request From Scratch","type":"object"},"Duplicate_a_Signature_Request":{"description":"Duplicate a Signature Request. It will be added to the same workspace as the original.","properties":{"signature_request_id":{"description":"ID of the signature request to duplicate.","example":"6c82bd7a-d7f7-45e0-82f4-b92222567346","format":"uuid","title":"Signature Request ID","type":"string"},"name":{"description":"The name of the new Signature Request.","example":"My duplicated Signature Request","maxLength":128,"minLength":1,"type":"string"},"workflow_session_id":{"$ref":"#/components/schemas/WorkflowSessionId"},"previous_attempt_id":{"$ref":"#/components/schemas/PreviousAttemptId"},"embedded_preparation":{"$ref":"#/components/schemas/SignatureRequest_EmbeddedPreparation"}},"required":["signature_request_id"],"title":"Duplicate a Signature Request","type":"object"},"SignatureRequest_reminder_settings":{"description":"Automatic reminder configuration; `null` if disabled.","nullable":true,"properties":{"interval_in_days":{"description":"Number of days between two reminders.","enum":[1,2,7,14],"format":"int32","type":"integer"},"max_occurrences":{"description":"Maximum number of reminders sent.","format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["interval_in_days","max_occurrences"],"type":"object"},"SignatureRequest_email_notification_sender":{"description":"Email sender configuration.","properties":{"type":{"description":"Identity used as the email sender.","enum":["organization","workspace","user","custom"],"type":"string"},"custom_name":{"description":"To use in association with sender type custom to precise the name","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["custom_name","type"],"type":"object"},"SignatureRequest_email_notification":{"description":"Email notification configuration.","properties":{"sender":{"$ref":"#/components/schemas/SignatureRequest_email_notification_sender"},"custom_note":{"description":"Custom note included in notification emails.","example":"Please sign these documents as soon as possible.","maxLength":2000,"nullable":true,"type":"string"}},"required":["custom_note","sender"],"type":"object"},"SignatureRequest_embedded_preparation_redirect_urls":{"description":"Redirect URLs for the Embedded Preparation navigation buttons.","properties":{"done":{"description":"URL the end-user is redirected to after clicking `Done`. If omitted, the default success screen is shown.","example":"https://example.com/done","format":"uri","nullable":true,"type":"string"},"back":{"description":"URL the end-user is redirected to after clicking `Back`. The `Back` button is shown only when this URL is set and its display setting is on.","example":"https://example.com/back","format":"uri","nullable":true,"type":"string"}},"required":["back","done"],"type":"object"},"SignatureRequest_embedded_preparation":{"description":"Embedded Preparation settings for this Signature Request.","properties":{"redirect_urls":{"$ref":"#/components/schemas/SignatureRequest_embedded_preparation_redirect_urls"}},"required":["redirect_urls"],"type":"object"},"SignatureRequest_decline_information":{"description":"Details of the decline, if a Signer declined.","nullable":true,"properties":{"signer_id":{"description":"Identifier of the Signer who declined.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"reason":{"description":"Reason given for declining.","type":"string"},"declined_at":{"description":"Timestamp when the Signer declined.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"}},"type":"object"},"SignatureRequest_rejection_information":{"description":"Information related to the rejection of a Signature Request by an Approver.","nullable":true,"properties":{"approver_id":{"description":"Id of the Approver who rejected the Signature Request.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"reason":{"description":"Reason provided by the Approver explaining why they rejected the Signature Request.","example":"I don't agree with the terms in the document.","type":"string"},"rejected_at":{"description":"Timestamp indicating when the Approver rejected the Signature Request.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"}},"readOnly":true,"type":"object"},"UpdateSignatureRequest_reminder_settings":{"description":"Automatic reminder configuration; set to `null` to disable.","nullable":true,"properties":{"interval_in_days":{"description":"Number of days between two reminders.","enum":[1,2,7,14],"format":"int32","type":"integer"},"max_occurrences":{"description":"Maximum number of reminders sent.","example":5,"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["interval_in_days","max_occurrences"],"type":"object"},"SignatureRequestActivated_documents_inner":{"properties":{"id":{"description":"Unique identifier of the Document.","type":"string"},"nature":{"description":"Nature of the Document (e.g. `attachment`, `signable_document`).","type":"string"}},"required":["id","nature"],"type":"object"},"Approver_info":{"properties":{"first_name":{"minLength":1,"type":"string"},"last_name":{"minLength":1,"type":"string"},"email":{"format":"email","minLength":1,"type":"string"},"phone_number":{"description":"E.164 format.","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale","phone_number"],"type":"object"},"New_Approver_From_Scratch_info":{"properties":{"first_name":{"maxLength":255,"minLength":1,"type":"string"},"last_name":{"maxLength":255,"minLength":1,"type":"string"},"email":{"maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format.","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale"],"type":"object"},"New_Approver_From_Scratch":{"description":"Create a new Approver from scratch.","properties":{"info":{"$ref":"#/components/schemas/New_Approver_From_Scratch_info"}},"required":["info"],"title":"New Approver From Scratch","type":"object"},"New_Approver_From_Existing_User":{"description":"Create a new Approver from an existing User.","properties":{"user_id":{"example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","type":"string"}},"required":["user_id"],"title":"New Approver From Existing User","type":"object"},"New_Approver_From_Existing_Contact":{"description":"Create a new Approver from an existing Contact.","properties":{"contact_id":{"example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","type":"string"}},"required":["contact_id"],"title":"New Approver From Existing Contact","type":"object"},"New_Approver_From_Existing_Signer":{"description":"Create a new Approver from an existing Signer.","properties":{"signer_id":{"example":"8b6ed2f3-244f-487a-baa1-bbe4f51c8744","format":"uuid","type":"string"}},"required":["signer_id"],"title":"New Approver From Existing Signer","type":"object"},"UpdateApprover_info":{"nullable":true,"properties":{"first_name":{"maxLength":255,"minLength":1,"type":"string"},"last_name":{"maxLength":255,"minLength":1,"type":"string"},"email":{"format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"type":"object"},"SignerConsentRequest_settings":{"description":"Settings relative to Signer Consent Request's type","properties":{"text":{"description":"Text associated to the checkbox or text_to_copy","example":"I agree with...","maxLength":1000,"minLength":1,"type":"string"}},"required":["text"],"type":"object"},"CreateSignerConsentRequest_settings":{"description":"Settings relative to Signer Consent Request's type","properties":{"text":{"description":"Text associated to the checkbox or the text_to_copy.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing URL.\n","example":"I agree with...","format":"safe-string","maxLength":1000,"minLength":1,"type":"string"}},"required":["text"],"type":"object"},"FieldRadioButtonGroup_radios_inner":{"properties":{"name":{"description":"Radio button's name.","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"x":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"format":"int32","maximum":32767,"minimum":0,"type":"integer"},"size":{"description":"The size determines both the width and height of the radio button.","format":"int32","maximum":240,"minimum":8,"type":"integer"},"checked":{"description":"Signer has checked the radio button.","type":"boolean"}},"required":["checked","name","size","x","y"],"type":"object"},"Signature":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["signature"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"height":{"description":"Default value is 37","example":37,"maximum":1000,"minimum":37,"type":"integer"},"width":{"description":"Default value is 85","example":150,"maximum":2000,"minimum":85,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Provide extra context to explain why the Document is being signed. Once the Document is signed, the custom reason is stored in the Audit Trail and is included in the signature certificate.\n\nThe default value is: \"Signed by [Signer first name] [Signer last name]\".\n\nThis parameter is only available for users with a `pro` or `scale` plan.\n","example":"Signed by John Doe","maxLength":150,"nullable":true,"type":"string"},"display":{"$ref":"#/components/schemas/SignatureDisplay_1"}},"required":["page","signer_id","type","x","y"],"title":"Signature","type":"object"},"Mention":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["mention"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the mention length.","example":250,"minimum":24,"type":"integer"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","example":150,"minimum":1,"nullable":true,"type":"integer"},"mention":{"description":"Content of the Mention.\\\nYou can use dynamic tags when creating the Mention:\\\n• `%date%` will display the current date when the Signer sign the Signature Request (eg. \"24-03-2025\")\\\n• `%datetime%` will display the current date and time when the Signer signs the Signature Request (eg. \"24-03-2025 10:30 UTC+0\")\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email.\n","example":"Signed on %date%","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},"font":{"$ref":"#/components/schemas/CreateFieldFont"},"name":{"description":"Name of the Field.","example":"Mention 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["mention","page","signer_id","type","x","y"],"title":"Mention","type":"object"},"SignatureDate":{"properties":{"signer_id":{"example":"b9142070-7039-4c19-ae30-67ac3e72ee7e","format":"uuid","type":"string"},"type":{"enum":["signature_date"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"font":{"$ref":"#/components/schemas/CreateSignatureDateFieldFont"},"name":{"description":"Name of the Field.","example":"Date 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"date_format":{"$ref":"#/components/schemas/CreateFieldDateFormat"},"time_format":{"$ref":"#/components/schemas/CreateFieldTimeFormat"},"show_timezone":{"default":false,"description":"Boolean indicating whether to display the timezone abbreviation (e.g., `CEST`) next to the time.","nullable":true,"type":"boolean"},"show_email":{"default":true,"description":"Boolean indicating whether to display the signer's email address.","nullable":false,"type":"boolean"},"offset_unit":{"$ref":"#/components/schemas/CreateFieldOffsetUnit"},"offset_value":{"default":0,"description":"Number of units to add to the signature date. Ignored if `offset_unit` is `null`. For example, use `offset_unit`: `\"month\"` and `offset_value: 3` to display \"signature date + 3 months\"","example":30,"minimum":0,"nullable":true,"type":"integer"}},"required":["page","signer_id","type","x","y"],"title":"SignatureDate","type":"object"},"Text":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["text"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the max_length value","example":90,"minimum":24,"type":"integer"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","example":150,"minimum":1,"type":"integer"},"max_length":{"example":120,"maximum":32767,"minimum":1,"type":"integer"},"question":{"description":"If you don't want any question, you can give an empty string.","example":"What is your job title?","maxLength":255,"type":"string"},"instruction":{"example":"Your position in the company","nullable":true,"type":"string"},"optional":{"default":false,"type":"boolean"},"font":{"$ref":"#/components/schemas/CreateFieldFont"},"name":{"description":"Name of the Field.","example":"Job Title","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"default_value":{"description":"If a default value is provided, the Field will be pre-filled with this value. The Signer can modify it before signing unless the Field is set to `read-only`.","example":"Software Engineer","maxLength":32767,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the Signer cannot modify the Field and the default value (if provided) will remain unchanged.","type":"boolean"}},"required":["max_length","page","question","signer_id","type","x","y"],"title":"Text","type":"object"},"Checkbox":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["checkbox"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"size":{"default":24,"example":24,"maximum":240,"minimum":8,"type":"integer"},"optional":{"default":false,"type":"boolean"},"name":{"example":"Checkbox 1","nullable":true,"type":"string"},"checked":{"default":false,"type":"boolean"},"read_only":{"default":false,"description":"If set to `true`, the checkbox cannot be modified by the signer.","type":"boolean"}},"required":["page","signer_id","type","x","y"],"title":"Checkbox","type":"object"},"RadioGroup_radios_inner":{"properties":{"name":{"description":"Radio button's name","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"size":{"default":24,"example":24,"maximum":240,"minimum":8,"type":"integer"},"default_checked":{"default":false,"description":"Indicates whether the radio is initially checked (`true`) or unchecked (`false`).","type":"boolean"}},"required":["x","y"],"type":"object"},"RadioGroup":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"enum":["radio_group"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"optional":{"default":false,"type":"boolean"},"name":{"description":"Radio group's name","example":"radio_group_name_1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the radio button cannot be modified by the Signer.","type":"boolean"},"radios":{"items":{"$ref":"#/components/schemas/RadioGroup_radios_inner"},"type":"array"}},"required":["page","radios","signer_id","type"],"title":"RadioGroup","type":"object"},"ReadOnlyText":{"properties":{"type":{"enum":["read_only_text"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the read only text length.","example":250,"minimum":24,"nullable":true,"type":"integer"},"height":{"description":"The height must be calculated using the formula: \"height = number_of_lines \\* font_size \\* line_height\", where the line height is always set to 1.5.","example":150,"minimum":1,"nullable":true,"type":"integer"},"text":{"example":"Order n°12345","maxLength":5000,"type":"string"},"font":{"$ref":"#/components/schemas/CreateFieldFont"}},"required":["page","text","type","x","y"],"title":"ReadOnlyText","type":"object"},"SignerName":{"properties":{"signer_id":{"example":"b0745f33-23d1-41c0-832e-27b968207cb9","format":"uuid","type":"string"},"type":{"enum":["signer_name"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"font":{"$ref":"#/components/schemas/CreateFieldFont"},"name":{"description":"Name of the Field.","example":"Name 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"name_format":{"$ref":"#/components/schemas/CreateFieldNameFormat"}},"required":["page","signer_id","type","x","y"],"title":"SignerName","type":"object"},"SignerEmail":{"properties":{"signer_id":{"example":"f5939433-43f0-423d-87d5-9ee80042fb0d","format":"uuid","type":"string"},"type":{"enum":["signer_email"],"type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":200,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"font":{"$ref":"#/components/schemas/CreateFieldFont"},"name":{"description":"Name of the Field.","example":"Email 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["page","signer_id","type","x","y"],"title":"SignerEmail","type":"object"},"Signature_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"height":{"description":"Default value is 37","example":50,"maximum":1000,"minimum":37,"type":"integer"},"width":{"description":"Default value is 85","example":200,"maximum":2000,"minimum":85,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Provide extra context to explain why the Document is being signed. Once the Document is signed, the custom reason is stored in the Audit Trail and is included in the signature certificate.\nThe default value is: \"Signed by [Signer first name] [Signer last name]\".\n","example":"Signed by John Doe","maxLength":150,"nullable":true,"type":"string"},"display":{"$ref":"#/components/schemas/SignatureDisplay_1"}},"title":"Signature","type":"object"},"Mention_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the read only text length.","example":200,"minimum":24,"type":"integer"},"height":{"description":"The height must be 24 or a multiple of 15 greater than 24. If height is not provided, it will be calculated depending on the number of newlines in the read only text.","example":150,"minimum":24,"nullable":true,"type":"integer"},"mention":{"description":"Content of the Mention.\nYou can use dynamic tags when creating the Mention:\n• %date% will display the current date when the Signer sign the Signature Request (eg. \"24-03-2025\")\n• %datetime% will display the current date and time when the Signer signs the Signature Request (eg. \"24-03-2025 10:30 UTC+0\")\n","example":"Signed on %date%","maxLength":255,"minLength":1,"type":"string"},"font":{"$ref":"#/components/schemas/UpdateFieldFont"},"name":{"description":"Name of the Field.","example":"Text 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"title":"Mention","type":"object"},"SignatureDate_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"font":{"$ref":"#/components/schemas/UpdateFieldFont"},"name":{"description":"Name of the Field.","example":"Date 1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"date_format":{"$ref":"#/components/schemas/CreateFieldDateFormat"},"time_format":{"$ref":"#/components/schemas/CreateFieldTimeFormat"},"show_timezone":{"default":false,"description":"Boolean indicating whether to display the timezone abbreviation (e.g., `CEST`) next to the time.","nullable":true,"type":"boolean"},"show_email":{"default":true,"description":"Boolean indicating whether to display the signer's email address.","nullable":false,"type":"boolean"},"offset_unit":{"$ref":"#/components/schemas/CreateFieldOffsetUnit"},"offset_value":{"default":0,"description":"Number of units to add to the signature date. Ignored if `offset_unit` is `null`. For example, use `offset_unit`: `\"month\"` and `offset_value: 3` to display \"signature date + 3 months\"","example":30,"minimum":0,"nullable":true,"type":"integer"}},"title":"SignatureDate","type":"object"},"Text_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the max_length value","example":200,"minimum":24,"type":"integer"},"height":{"description":"The height must be 24 or a multiple of 15 greater than 24.","example":150,"minimum":24,"type":"integer"},"max_length":{"example":150,"maximum":32767,"minimum":1,"type":"integer"},"question":{"description":"If you don't want any question, you can give an empty string.","example":"What is your job title?","maxLength":255,"type":"string"},"instruction":{"example":"Your position in the company","nullable":true,"type":"string"},"optional":{"default":false,"type":"boolean"},"font":{"$ref":"#/components/schemas/UpdateFieldFont"},"name":{"description":"Name of the Field.","example":"Job Title","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"default_value":{"description":"If a default value is provided, the Field will be pre-filled with this value. The Signer can modify it before signing unless the Field is set to `read-only`.","example":"Software Engineer","maxLength":32767,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the Signer cannot modify the Field and the default value (if provided) will remain unchanged.","type":"boolean"}},"title":"Text","type":"object"},"Checkbox_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"size":{"default":24,"example":24,"maximum":240,"minimum":8,"type":"integer"},"optional":{"default":false,"type":"boolean"},"name":{"example":"Checkbox 1","nullable":true,"type":"string"},"checked":{"default":false,"type":"boolean"},"read_only":{"default":false,"description":"If set to `true`, the checkbox cannot be modified by the Signer.","type":"boolean"}},"title":"Checkbox","type":"object"},"RadioGroup_1_radios_inner":{"properties":{"name":{"description":"Radio button's name","example":"My radio group","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"size":{"default":24,"example":24,"maximum":240,"minimum":8,"type":"integer"}},"required":["x","y"],"type":"object"},"RadioGroup_1":{"properties":{"signer_id":{"example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"page":{"example":1,"minimum":1,"type":"integer"},"optional":{"default":false,"type":"boolean"},"name":{"description":"Radio group's name","example":"radio_group_name_1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the radio button cannot be modified by the Signer.","type":"boolean"},"radios":{"items":{"$ref":"#/components/schemas/RadioGroup_1_radios_inner"},"type":"array"}},"title":"RadioGroup","type":"object"},"ReadOnlyText_1":{"properties":{"page":{"example":1,"minimum":1,"type":"integer"},"x":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"y":{"example":400,"maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the mention length.","example":24,"minimum":24,"nullable":true,"type":"integer"},"height":{"description":"The height must be 24 or a multiple of 15 greater than 24. If height is not provided, it will be calculated depending on the number of newlines in the mention.","example":150,"minimum":24,"nullable":true,"type":"integer"},"text":{"example":"Order n°12345","maxLength":5000,"type":"string"},"font":{"$ref":"#/components/schemas/UpdateFieldFont"}},"title":"ReadOnlyText","type":"object"},"FieldAnswer_value":{"oneOf":[{"description":"The answer value for a text field. Can be null if the field is not required.\nThe selected radio name in a radio group.\n","example":"My custom answer or my radio name in the group","maxLength":32767,"minLength":1,"title":"Answer Text or a Radio Group Field","type":"string"},{"description":"The answer value for a checkbox field.","example":true,"title":"Answer Checkbox Field","type":"boolean"}]},"CreateFollowers_inner":{"properties":{"email":{"example":"john.doe@example.com","format":"email","maxLength":100,"minLength":1,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","locale"],"type":"object"},"Metadata_data_value":{"oneOf":[{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email, URL and leading or trailing whitespaces.","format":"safe-string","maxLength":255,"minLength":1,"type":"string"},{"type":"number"},{"type":"boolean"}]},"Signer_info":{"properties":{"first_name":{"minLength":1,"type":"string"},"last_name":{"minLength":1,"type":"string"},"email":{"format":"email","minLength":1,"type":"string"},"phone_number":{"description":"E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale","phone_number"],"type":"object"},"Signer_fields_inner":{"oneOf":[{"$ref":"#/components/schemas/FieldSignature"},{"$ref":"#/components/schemas/FieldText"},{"$ref":"#/components/schemas/FieldMention"},{"$ref":"#/components/schemas/FieldCheckbox"},{"$ref":"#/components/schemas/FieldRadioButtonGroup"}]},"Signer_redirect_urls":{"description":"","properties":{"success":{"example":"https://example.com/success","format":"uri","minLength":1,"nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","minLength":1,"nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","minLength":1,"nullable":true,"type":"string"}},"required":["decline","error","success"],"type":"object"},"New_Signer_From_Scratch_info":{"properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale"],"type":"object"},"New_Signer_From_Scratch_redirect_urls":{"properties":{"success":{"example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"New_Signer_From_Scratch_custom_text":{"properties":{"request_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"New_Signer_From_Scratch":{"description":"Create a new signer from scratch","properties":{"info":{"$ref":"#/components/schemas/New_Signer_From_Scratch_info"},"fields":{"description":"Fields to assign to the Signer. Multiple Fields can be added simultaneously.","items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be a signer. `ordered_signers` must be enabled on the Signature Request.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signature_level":{"enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":["otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/New_Signer_From_Scratch_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/New_Signer_From_Scratch_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"},"identification_attestation_id":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"sms_notification":{"$ref":"#/components/schemas/SmsNotification_1"},"email_notification":{"$ref":"#/components/schemas/EmailNotification_1"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","type":"boolean"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"}},"required":["info","signature_level"],"title":"New Signer From Scratch","type":"object"},"New_Signer_From_Existing_User_custom_text":{"properties":{"request_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":150,"minLength":1,"nullable":true,"type":"string"},"request_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":150,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"description":"This property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string) allowing email and leading or trailing whitespaces.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"New_Signer_From_Existing_User":{"description":"Create a new signer from an existing user","properties":{"user_id":{"description":"Create signer from an existing user","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"fields":{"items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be a signer. `ordered_signers` must be enabled on the Signature Request.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signature_level":{"enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":["otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/New_Signer_From_Scratch_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/New_Signer_From_Existing_User_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"},"identification_attestation_id":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"sms_notification":{"$ref":"#/components/schemas/SmsNotification_1"},"email_notification":{"$ref":"#/components/schemas/EmailNotification_1"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","nullable":false,"type":"boolean"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"}},"required":["signature_level","user_id"],"title":"New Signer From Existing User","type":"object"},"New_Signer_From_Existing_Contact":{"description":"Create a new signer from an existing contact","properties":{"contact_id":{"description":"Create signer from an existing contact","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"fields":{"items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be a signer. `ordered_signers` must be enabled on the Signature Request.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signature_level":{"enum":["electronic_signature","advanced_electronic_signature","qualified_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":["otp_email","otp_sms","no_otp"],"nullable":true,"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/New_Signer_From_Scratch_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/New_Signer_From_Existing_User_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"},"identification_attestation_id":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"sms_notification":{"$ref":"#/components/schemas/SmsNotification_1"},"email_notification":{"$ref":"#/components/schemas/EmailNotification_1"},"pre_identity_verification_required":{"description":"Defines the way the Signer's Identity Documents will be uploaded for Verification. If set to `true`, `signature_level`should be equal to `advanced_electronic_signature` and `delivery_mode` set to `none`.","nullable":false,"type":"boolean"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"}},"required":["contact_id","signature_level"],"title":"New Signer From Existing Contact","type":"object"},"New_Signer_From_Identity_Verification_info":{"properties":{"email":{"format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.","example":"+41446667700","minLength":1,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","locale","phone_number"],"type":"object"},"New_Signer_From_Identity_Verification_custom_text":{"properties":{"request_subject":{"maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"New_Signer_From_Identity_Verification":{"description":"Create a new signer from an identity verification","properties":{"verified_identity_id":{"description":"Create a signer from an identity verification. The signature level must be set to `advanced_electronic_signature`.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"info":{"$ref":"#/components/schemas/New_Signer_From_Identity_Verification_info"},"fields":{"description":"Fields to assign to the Signer. Multiple Fields can be added simultaneously.","items":{"$ref":"#/components/schemas/FieldsInput"},"type":"array"},"insert_after_id":{"description":"ID of the recipient this one must follow in an ordered flow; they will only be asked to act after that recipient.\nWhen `custom_recipient_order` is enabled, this can reference any approver or signer.\nWhen `custom_recipient_order` is disabled, the referenced ID must be a signer. `ordered_signers` must be enabled on the Signature Request.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"group_with_id":{"description":"ID of another recipient (Approver or Signer); both will be allowed to act in parallel in an ordered flow.\nOnly available when `custom_recipient_order` is enabled.\n","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","nullable":true,"type":"string"},"signature_level":{"enum":["advanced_electronic_signature"],"type":"string"},"signature_authentication_mode":{"description":"Method to authenticate the Signers. Authentication via SMS one-time password (otp_sms) is unavailable for phone numbers in China.","enum":["otp_sms"],"type":"string"},"redirect_urls":{"$ref":"#/components/schemas/New_Signer_From_Scratch_redirect_urls"},"custom_text":{"$ref":"#/components/schemas/New_Signer_From_Identity_Verification_custom_text"},"delivery_mode":{"$ref":"#/components/schemas/SignerDeliveryMode"},"sms_notification":{"$ref":"#/components/schemas/SmsNotification_1"},"email_notification":{"$ref":"#/components/schemas/EmailNotification_1"},"excluded_documents":{"$ref":"#/components/schemas/ExcludedDocuments"},"disabled_signing_contexts":{"$ref":"#/components/schemas/DisabledSigningContexts"}},"required":["info","signature_authentication_mode","signature_level","verified_identity_id"],"title":"New Signer From Identity Verification","type":"object"},"UpdateSigner_info":{"nullable":true,"properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"type":"object"},"Signer_s_IP_address":{"description":"Signer's public IP address at the time of signing. Private IP addresses (e.g. 10.x.x.x, 172.16-31.x.x, 192.168.x.x) are not accepted, as a public IP is required to be recorded in the Audit Trail.","oneOf":[{"example":"192.0.2.146","format":"ipv4","title":"IPv4","type":"string"},{"example":"2001:0000:130F:0000:0000:09C0:876A:130B","format":"ipv6","title":"IPv6","type":"string"}],"title":"Signer's IP address"},"User_workspaces_inner":{"properties":{"id":{"example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"InitiateBankAccountLookupWithNaturalPerson_natural_person":{"description":"Information about the natural person who owns the bank account","properties":{"first_name":{"description":"First name of the person","example":"John","maxLength":255,"nullable":false,"type":"string"},"last_name":{"description":"Last name of the person","example":"Doe","maxLength":255,"nullable":false,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"BankAccountLookupFull_data_extracted_from_document":{"nullable":true,"properties":{"iban":{"description":"The IBAN number extracted from the document.","example":"FR7630006000011234567890189","nullable":true,"type":"string"}},"type":"object"},"BankAccountLookupFull_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/BankAccountLookupFull_data_extracted_from_document"}},"required":["extracted_from_document"],"type":"object"},"InitiateBankAccountWithLegalPerson_legal_person":{"additionalProperties":false,"description":"The field can not be submitted if field \"natural_person\" is provided.","properties":{"name":{"description":"Please provide the legal entity name, exactly as it appears on the bank account document.\nPlease match it exactly, with the same characters, same case.\n","example":"Foundation Teaming","maxLength":128,"minLength":1,"type":"string"}},"type":"object"},"InitiateBankAccountWithNaturalPerson_natural_person":{"additionalProperties":false,"description":"The field can not be submitted if field \"legal_person\" is provided.","properties":{"first_name":{"description":"Please provide the holder first name, exactly as it appears on the bank account document.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\n","example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"description":"Please provide the holder last name, exactly as it appears on the bank account document.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\n","example":"Doe","maxLength":255,"minLength":1,"type":"string"}},"type":"object"},"BankAccountFull_allOf_data_extracted_from_document":{"description":"Data extracted from the provided bank account document","properties":{"iban":{"$ref":"#/components/schemas/NullableIBAN"},"bic":{"$ref":"#/components/schemas/NullableBIC"}},"required":["bic","iban"],"type":"object"},"BankAccountFull_allOf_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/BankAccountFull_allOf_data_extracted_from_document"}},"required":["extracted_from_document"],"type":"object"},"CompanyFull_allOf_data_extracted_from_document":{"properties":{"company_number":{"description":"Company number extracted from the document.","nullable":true,"type":"string"},"issued_on":{"description":"Date when the document was issued.","format":"date","nullable":true,"type":"string"}},"type":"object"},"CompanyFull_allOf_data_company_information_legal_form":{"properties":{"code":{"description":"Legal form code (ISO 20275).","example":"6CHY","nullable":true,"type":"string"},"description":{"description":"Local legal form name.","example":"SAS, société par actions simplifiée","nullable":true,"type":"string"}},"required":["code","description"],"type":"object"},"CompanyFull_allOf_data_company_information_activities":{"properties":{"code":{"description":"Activity code.","example":"62.01","nullable":true,"type":"string"},"description":{"description":"Activity name.","example":"Computer programming activities","nullable":true,"type":"string"},"classification":{"description":"Activity classification.","example":"NACE","nullable":true,"type":"string"}},"required":["classification","code","description"],"type":"object"},"CompanyFull_allOf_data_company_information_commercial_registration":{"properties":{"location":{"description":"Indicates the location of the company's commercial register.","example":"CAEN","nullable":true,"type":"string"},"registered_on":{"description":"Indicates the company's registration date in the commercial register.","example":"2013-08-01","format":"date","nullable":true,"type":"string"}},"required":["location","registered_on"],"type":"object"},"CompanyFull_allOf_data_company_information":{"properties":{"name":{"description":"Denomination of the company.","example":"YOUTRUST","nullable":true,"type":"string"},"trade_name":{"description":"Trade name of the company.","nullable":true,"type":"string"},"company_number":{"description":"The number of the company entity.","example":"794513986","nullable":true,"type":"string"},"partial_data":{"description":"Describes if a company has declined to make some of her data public (ie : legal representatives personal data), when true data might be missing from the response","example":true,"nullable":true,"type":"boolean"},"required_document_type":{"description":"Provides the right document type to request for a given company based on its registry. ie: company_certificate, rne_certificate or business_registration_certificate. You can use those types when calling Document Analysis.","example":["company_certificate"],"items":{"enum":["company_certificate","business_registration_certificate","rne_certificate"],"type":"string"},"type":"array"},"legal_form":{"$ref":"#/components/schemas/CompanyFull_allOf_data_company_information_legal_form"},"vat_number":{"description":"Tax number of the company.","example":"FR61794513986","nullable":true,"type":"string"},"activities":{"items":{"$ref":"#/components/schemas/CompanyFull_allOf_data_company_information_activities"},"type":"array"},"founded_on":{"description":"Company's creation date.","example":"2013-07-24","format":"date","nullable":true,"type":"string"},"ceased_on":{"description":"Indicates the company's cessation date if company is inactive, otherwise null.","format":"date","nullable":true,"type":"string"},"active":{"description":"Indicates whether or not the company is still active.","nullable":true,"type":"boolean"},"commercial_registration":{"$ref":"#/components/schemas/CompanyFull_allOf_data_company_information_commercial_registration"},"has_workforce":{"description":"True if the company has at least one employee.","nullable":true,"type":"boolean"}},"type":"object"},"CompanyFull_allOf_data_headquarter":{"properties":{"address_line_1":{"example":"AVENUE PIERRE BERTHELOT","nullable":true,"type":"string"},"address_line_2":{"nullable":true,"type":"string"},"postal_code":{"example":"14000","nullable":true,"type":"string"},"city":{"example":"CAEN","nullable":true,"type":"string"},"country_code":{"example":"FR","nullable":true,"type":"string"}},"required":["address_line_1","address_line_2","city","country_code","postal_code"],"type":"object"},"CompanyFull_allOf_data_legal_representatives":{"properties":{"title":{"description":"The representative's role within the company.","example":"Président","nullable":true,"type":"string"},"type":{"description":"Indicates whether the representative is a natural person or a legal entity.","enum":["natural_person","legal_person"],"nullable":true,"type":"string"},"first_name":{"description":"The representative's first name in case of a natural person, otherwise null.","example":"John","nullable":true,"type":"string"},"last_name":{"description":"The representative's last name in case of a natural person, otherwise null.","example":"Doe","nullable":true,"type":"string"},"birth_name":{"description":"The representative's birth name in case of a natural person, otherwise null.","example":"Doe","nullable":true,"type":"string"},"born_on":{"description":"The representative's birthdate in case of a natural person, otherwise null.","example":"1994-04-20","format":"date","nullable":true,"type":"string"},"company_name":{"description":"The representative's company name in case of a legal person, otherwise null.","nullable":true,"type":"string"},"company_number":{"description":"The representative's company number in case of a legal person, otherwise null.","nullable":true,"type":"string"}},"required":["birth_name","born_on","company_name","company_number","first_name","last_name","title","type"],"type":"object"},"CompanyFull_allOf_data_beneficial_owners":{"properties":{"first_name":{"description":"The beneficial owner's first name.","example":"Aline","nullable":true,"type":"string"},"last_name":{"description":"The beneficial owner's last name.","example":"Alix","nullable":true,"type":"string"},"gender":{"description":"The beneficial owner's gender, as declared in the register. \"f\" for Female, \"m\" for Male, \"x\" for Non-binary or unspecified.","enum":["f","m","x",null],"example":"f","nullable":true,"type":"string"},"born_on":{"description":"The beneficial owner's date of birth, as declared in the register. Registers are only required to publish the month of birth, so this is usually a partial date (`YYYY-MM`) rather than a full one (`YYYY-MM-DD`).\n","example":"1972-04","nullable":true,"type":"string"},"percentage_of_shares":{"description":"Share of the company's capital held by the beneficial owner, in percent. Null when the register does not declare it.","example":75,"nullable":true,"type":"number"},"voting_percentage":{"description":"Share of the company's voting rights held by the beneficial owner, in percent. Null when the register does not declare it.","example":75,"nullable":true,"type":"number"}},"required":["born_on","first_name","gender","last_name","percentage_of_shares","voting_percentage"],"type":"object"},"CompanyFull_allOf_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/CompanyFull_allOf_data_extracted_from_document"},"company_information":{"$ref":"#/components/schemas/CompanyFull_allOf_data_company_information"},"headquarter":{"$ref":"#/components/schemas/CompanyFull_allOf_data_headquarter"},"legal_representatives":{"items":{"$ref":"#/components/schemas/CompanyFull_allOf_data_legal_representatives"},"type":"array"},"beneficial_owners":{"description":"The company's ultimate beneficial owners, as declared in the local beneficial ownership register. Only available for French companies, and only if your organization subscribed to the corresponding add-on. Empty otherwise, and empty while the verification is still pending or once its data has been anonymized.\n","items":{"$ref":"#/components/schemas/CompanyFull_allOf_data_beneficial_owners"},"type":"array"}},"type":"object"},"IdentityDocumentFull_allOf_data_extracted_from_document_mrz":{"description":"Machine Readable Zone content","properties":{"line1":{"description":"MRZ line 1","example":"IDFRASIAGRA<<<<<<<<<<<<<<<<<<<133039","nullable":true,"type":"string"},"line2":{"description":"MRZ line 2","example":"1002133008071GREGOIRE<<REMY8110228M4","nullable":true,"type":"string"},"line3":{"description":"MRZ line 3","example":"<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<","nullable":true,"type":"string"}},"required":["line1","line2","line3"],"type":"object"},"IdentityDocumentFull_allOf_data_extracted_from_document":{"description":"Information extracted from the verified identity document","properties":{"first_name":{"description":"The document holder's first name as it appears on the identity document","example":"John","minLength":1,"nullable":true,"type":"string"},"birth_name":{"description":"The document holder's birth name (family name at birth)","example":"Doe","minLength":1,"nullable":true,"type":"string"},"last_name":{"description":"The document holder's current last name (may differ from birth name)","example":"Doe","minLength":1,"nullable":true,"type":"string"},"born_on":{"description":"The document holder's date of birth as it appears on the document","example":"2024-01-18","format":"date","nullable":true,"type":"string"},"birth_location":{"description":"The holder's place of birth as it appears on the document","example":"Paris","minLength":1,"nullable":true,"type":"string"},"gender":{"description":"The holder's gender as it appears on the document. \"m\" for Male, \"f\" for Female, \"x\" for Non-binary or unspecified.","enum":["f","m","x",null],"example":"f","nullable":true,"type":"string"},"full_address":{"description":"The holder's complete postal address as it appears on the document","example":"13 RUE SAINT MARCELIN\nMARSEILLE 10E (13)","minLength":1,"nullable":true,"type":"string"},"type":{"description":"The type of identity document that was verified","enum":["id_card","passport","residence_permit","ita_ts_cns",null],"example":"id_card","nullable":true,"type":"string"},"issuing_country_code":{"description":"The country that issued the document (ISO 3166-1 alpha-2 code)","example":"US","format":"ISO 3166-1 alpha-2","nullable":true,"pattern":"^[A-Za-z]{2}$","type":"string"},"issued_on":{"description":"The date when the document was issued","example":"2024-01-18","format":"date","nullable":true,"pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"expired_on":{"description":"The date when the document legally expires","example":"2024-01-18","format":"date","nullable":true,"pattern":"^\\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"document_number":{"description":"Document identifier number (may contain letters)","example":"X4RTBPFW4","nullable":true,"type":"string"},"mrz":{"$ref":"#/components/schemas/IdentityDocumentFull_allOf_data_extracted_from_document_mrz"},"national_identification_number":{"description":"Some documents may contain a national identification number.\nFor example, Italian ID cards contain the Codice Fiscale on the back of the document.\nWhen this data is available on the document, it will be returned here, otherwise it will be NULL.\nConsult our [guide](https://developers.youtrust.com/docs/identity-document-verification) for more details and examples.\n","example":"MLLSNT82P65Z404U","nullable":true,"type":"string"}},"required":["birth_location","birth_name","born_on","document_number","expired_on","first_name","full_address","gender","issued_on","issuing_country_code","last_name","mrz","national_identification_number","type"],"type":"object"},"IdentityDocumentFull_allOf_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/IdentityDocumentFull_allOf_data_extracted_from_document"}},"required":["extracted_from_document"],"type":"object"},"IdentityVideoFull_allOf_data_evidence":{"description":"Documentary evidence captured during the verification process","properties":{"document_front_image_url":{"description":"Temporary public link to the front image. Available for 10 minutes after the user completed the verification.","example":"https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/aaa.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx","format":"uri","minLength":1,"nullable":true,"type":"string"},"document_back_image_url":{"description":"Temporary public link to the back image. Available for 10 minutes after the user completed the verification.","example":"https://storage-b.env.ubble.ai/ubble-ai/88bf48f0-ce4a-449c-9af1-f138a7e09392/ae1f813a-02cf-4ffc-bf71-d823ed74dc8d/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/bbb.png?X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx","format":"uri","minLength":1,"nullable":true,"type":"string"},"face_image_url":{"description":"Temporary public link to the face image. Available for 10 minutes after the user completed the verification.","example":"https://storage-b.ubble.ai/11-production-ubble-ai/CKQNCMWHRPGT/idv_01jezpmz01mvn7r1n9eg596v5k/9a873da8-2395-4b05-b9a6-56644dfe2e06/9dc6948e-23b8-4405-81f2-28dccc0d9a71/face_asset_generation_0_rtc_face_0_rtc_face/face_crop_41.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=h6aivdggwQIvVyGWnAEw%2F20241216%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20241216T100820Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=xxx","format":"uri","minLength":1,"nullable":true,"type":"string"}},"required":["document_back_image_url","document_front_image_url","face_image_url"],"type":"object"},"IdentityVideoFull_allOf_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/IdentityVideoDocument"},"evidence":{"$ref":"#/components/schemas/IdentityVideoFull_allOf_data_evidence"}},"required":["evidence","extracted_from_document"],"type":"object"},"InitiateProofOfAddress_natural_person_address":{"additionalProperties":false,"description":"Provide the holder full address, exactly as it should appear on the proof of address document.","nullable":true,"properties":{"line1":{"description":"The first line of the address, typically the street name and number.","example":"Rue De Suède","maxLength":500,"minLength":1,"type":"string"},"line2":{"description":"If needed, the second line of the address, typically an apartment or suite number.","maxLength":500,"minLength":1,"nullable":true,"type":"string","example":null},"postal_code":{"description":"The postal code of the address.","example":"14000","maxLength":10,"minLength":1,"type":"string"},"city":{"description":"The city of the address.","example":"CAEN","maxLength":200,"minLength":1,"type":"string"}},"required":["city","line1","postal_code"],"type":"object"},"InitiateProofOfAddress_natural_person":{"additionalProperties":false,"properties":{"first_name":{"description":"Provide the holder first name, exactly as it should appear on the proof of address document.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\nThis field can not be submitted without field \"last_name\".\n","example":"John","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"last_name":{"description":"Provide the holder last name, exactly as it should appear on the proof of address document.\nPlease match it exactly, with the same characters, same case.\nOne exception: if the document mentions an honorary title, please don't provide it as part of the name.\nThis field can not be submitted without field \"first_name\".\n","example":"Doe","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"address":{"$ref":"#/components/schemas/InitiateProofOfAddress_natural_person_address"}},"type":"object"},"ProofOfAddressVerificationFull_allOf_data_extracted_from_document_2d_doc_address":{"description":"If found, the address extracted from the 2D-Doc.","properties":{"line1":{"description":"The street type, name and number.","example":"18 rue de Londres","minLength":1,"nullable":true,"type":"string"},"postal_code":{"description":"The postal code.","example":"75008","minLength":1,"nullable":true,"type":"string"},"city":{"description":"The city name.","example":"Paris","minLength":1,"nullable":true,"type":"string"},"country_code":{"example":"FR","format":"ISO 3166-1 alpha-2","maxLength":2,"minLength":1,"nullable":true,"pattern":"^[A-Za-z]{2}$","type":"string"}},"required":["city","country_code","line1","postal_code"],"type":"object"},"ProofOfAddressVerificationFull_allOf_data_extracted_from_document_2d_doc":{"description":"Data extracted from the 2D-Doc if the document has one.","properties":{"full_name":{"description":"If found, the full name extracted from the 2D-Doc.","example":"John Doe","minLength":1,"nullable":true,"type":"string"},"address":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull_allOf_data_extracted_from_document_2d_doc_address"}},"required":["address","full_name"],"type":"object"},"ProofOfAddressVerificationFull_allOf_data_extracted_from_document":{"description":"Data extracted from the provided proof of address document","properties":{"first_name":{"description":"If found, the first name as it appeared on the document.","example":"John","minLength":1,"nullable":true,"type":"string"},"last_name":{"description":"If found, the last name as it appeared on the document.","example":"Doe","minLength":1,"nullable":true,"type":"string"},"full_address":{"description":"If found, the address as it appeared on the document.","example":"Rue De Suède Av Pierre Berthelot 14000 CAEN","minLength":1,"nullable":true,"type":"string"},"issued_on":{"description":"If found, the document's issuance date as it appeared on the document.","example":"2022-01-01","format":"date","nullable":true,"type":"string"},"document_type":{"description":"The type of document that was verified","enum":["driver_license","energy_invoice","energy_schedule","family_allowance","id_card","insurance_attestation","italian_national_service_card","local_residence_tax_notice","passport","payslip","photograph","phone_invoice","property_tax_notice","provider_attestation","residence_permit","retirement_pension","rib","tax_justification","tax_notice","vehicle_registration_certificate"],"example":"tax_notice","nullable":true,"type":"string"},"2d_doc":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull_allOf_data_extracted_from_document_2d_doc"}},"required":["2d_doc","first_name","full_address","issued_on","last_name"],"type":"object"},"ProofOfAddressVerificationFull_allOf_data":{"properties":{"extracted_from_document":{"$ref":"#/components/schemas/ProofOfAddressVerificationFull_allOf_data_extracted_from_document"}},"required":["extracted_from_document"],"type":"object"},"InitiateWatchlist_natural_person":{"description":"Information about the person to check","properties":{"first_name":{"description":"First name of the person","example":"Emmanuel","nullable":false,"type":"string"},"last_name":{"description":"Last name of the person","example":"Macron","nullable":false,"type":"string"},"born_on":{"description":"Date of birth of the person (YYYY-MM-DD)","example":"1977-12-21","format":"date","nullable":false,"type":"string"}},"required":["born_on","first_name","last_name"],"type":"object"},"WatchlistFull_allOf_data_politically_exposed_person_sources":{"properties":{"name":{"description":"Name of the source","example":"Wikidata Politically Exposed Persons","nullable":true,"type":"string"},"url":{"description":"URL of the source","example":"https://www.opensanctions.org/datasets/wd_peps","nullable":true,"type":"string"}},"required":["name","url"],"type":"object"},"WatchlistFull_allOf_data_politically_exposed_person_positions":{"properties":{"title":{"description":"Title of the political position","example":"Minister of Finance","nullable":true,"type":"string"},"active":{"description":"Whether the person is currently politically exposed","example":false,"type":"boolean"},"country_code":{"description":"ISO country code where the position is held","example":"FR","format":"ISO 3166-1 alpha-2","nullable":true,"type":"string"},"started_on":{"description":"Date when the position started","example":"2020-01-01","nullable":true,"type":"string"},"ended_on":{"description":"Date when the position ended − null if ongoing","example":"2021-01-01","nullable":true,"type":"string"},"sources":{"description":"Sources of this information","items":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person_sources"},"type":"array"}},"required":["active","country_code","ended_on","sources","started_on","title"],"type":"object"},"WatchlistFull_allOf_data_politically_exposed_person":{"description":"Information about politically exposed person status","properties":{"active":{"description":"Whether the person is currently politically exposed","type":"boolean"},"positions":{"items":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person_positions"},"type":"array"}},"required":["active","positions"],"type":"object"},"WatchlistFull_allOf_data_sanctions_sources":{"properties":{"name":{"description":"Name of the source","example":"CIA World Factbook heads of state and government","nullable":true,"type":"string"},"url":{"description":"URL of the source","example":"https://www.opensanctions.org/datasets/us_cia_world_factbook","nullable":true,"type":"string"}},"required":["name","url"],"type":"object"},"WatchlistFull_allOf_data_sanctions_records":{"properties":{"description":{"description":"Description of the sanction","example":"Management ban","nullable":true,"type":"string"},"authority":{"description":"Authority that issued the sanction","example":"Commercial Court of Paris","nullable":true,"type":"string"},"country_code":{"description":"ISO country code where the sanction is applicable","example":"FR","format":"ISO 3166-1 alpha-2","nullable":true,"type":"string"},"active":{"description":"Whether the sanction is currently active","example":false,"type":"boolean"},"started_on":{"description":"Date when the sanction started","example":"2020-01-01","nullable":true,"type":"string"},"ended_on":{"description":"Date when the sanction ended − null if ongoing","example":"2021-01-01","nullable":true,"type":"string"},"sources":{"description":"Sources of this information","items":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_sanctions_sources"},"type":"array"}},"required":["active","authority","country_code","description","ended_on","sources","started_on"],"type":"object"},"WatchlistFull_allOf_data_sanctions":{"description":"List of sanctions against the person","properties":{"active":{"description":"Whether the person is currently sanctioned.","type":"boolean"},"records":{"items":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_sanctions_records"},"type":"array"}},"required":["active","records"],"type":"object"},"WatchlistFull_allOf_data":{"description":"Verification result data","properties":{"politically_exposed_person":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_politically_exposed_person"},"sanctions":{"$ref":"#/components/schemas/WatchlistFull_allOf_data_sanctions"}},"required":["politically_exposed_person","sanctions"],"type":"object"},"WebhookSubscription_subscribed_events":{"description":"Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs.","oneOf":[{"$ref":"#/components/schemas/WebhookWildcardSubscribedEvent"},{"$ref":"#/components/schemas/WebhookSubscribedEvents"}]},"WebhookSubscription_scopes":{"oneOf":[{"$ref":"#/components/schemas/WebhookWildcardScope"},{"$ref":"#/components/schemas/WebhookScopes"}]},"WebhookSubscription_workspaces":{"oneOf":[{"$ref":"#/components/schemas/WebhookWildcardWorkspace"},{"$ref":"#/components/schemas/WebhookWorkspaces"}]},"CreateWebhookSubscription_subscribed_events":{"description":"Select all the events to subscribe to.","oneOf":[{"$ref":"#/components/schemas/WebhookSubscribedEvents"},{"$ref":"#/components/schemas/WebhookWildcardSubscribedEvent"}]},"CreateWebhookSubscription_scopes":{"description":"Choose between a wildcard symbol to select all scopes or specify a list of specific scopes.","oneOf":[{"$ref":"#/components/schemas/WebhookScopes"},{"$ref":"#/components/schemas/WebhookWildcardScope"}]},"CreateWebhookSubscription_workspaces":{"description":"Choose between a wildcard symbol to select all Workspaces or specify a list of specific Workspace UUIDs. The association of specific Workspaces with Webhook is temporarily restricted in the sandbox environment, only the value wildcard (\"*\") for Workspaces is allowed in this context.","oneOf":[{"$ref":"#/components/schemas/WebhookWorkspaces"},{"$ref":"#/components/schemas/WebhookWildcardWorkspace"}]},"WorkflowSession_action_groups_inner_actions_inner_resolution":{"description":"The resource associated with this Action.","nullable":true,"properties":{"reason":{"description":"The reason why the Action is marked as resolved.","example":"Manual verification.","maxLength":150,"nullable":true,"type":"string"},"resolved_at":{"example":"2024-01-18T22:59:00Z","format":"date-time","readOnly":true,"type":"string"}},"required":["reason","resolved_at"],"type":"object"},"WorkflowSession_action_groups_inner_actions_inner_previous_attempts_inner":{"properties":{"resource":{"$ref":"#/components/schemas/WorkflowSessionActionResource"}},"required":["resource"],"type":"object"},"WorkflowSession_action_groups_inner_actions_inner":{"description":"An Action.","properties":{"resource":{"$ref":"#/components/schemas/WorkflowSessionActionResource"},"resolution":{"$ref":"#/components/schemas/WorkflowSession_action_groups_inner_actions_inner_resolution"},"previous_attempts":{"description":"List of previous attempts for this action. Each one contains a resource with its associated details.","items":{"$ref":"#/components/schemas/WorkflowSession_action_groups_inner_actions_inner_previous_attempts_inner"},"type":"array"}},"required":["previous_attempts","resolution","resource"],"type":"object"},"WorkflowSession_action_groups_inner":{"description":"An Action Group.","properties":{"type":{"description":"Type of the Action Group.","enum":["signature_request","identity_verification","proof_of_address_verification","company_verification","watchlist_verification","bank_account_verification","document_analysis"],"example":"identity_verification","type":"string"},"status":{"description":"Status of the Action Group.","enum":["awaiting","ongoing","blocked","done"],"example":"ongoing","type":"string"},"actions":{"description":"Actions represent the resources associated with this Workflow Session, such as a Signature Request, Identity Document Verification, or other types of verifications. Actions of the same type are gathered in the same Action Group.","items":{"$ref":"#/components/schemas/WorkflowSession_action_groups_inner_actions_inner"},"type":"array"}},"required":["actions","status","type"],"type":"object"},"Natural_Person_Applicant":{"additionalProperties":false,"description":"A natural person Applicant.","properties":{"id":{"description":"Unique identifier of the Applicant.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"description":"Unique identifier of the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"status":{"description":"Status of the Applicant.","enum":["initiated","notified","processed"],"example":"initiated","type":"string"},"label":{"description":"Label of the Applicant.","example":"John Doe","type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"created_at":{"description":"Creation date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Last update date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"type":{"description":"Type of the Applicant.","enum":["natural_person"],"type":"string"},"natural_person":{"$ref":"#/components/schemas/NaturalPerson"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session), or null for a root / standalone Applicant.","format":"uuid","nullable":true,"type":"string","example":null},"child_applicant_ids":{"description":"The ids of the child Applicants; empty for a natural_person or a childless root.","example":[],"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["child_applicant_ids","created_at","delivery_mode","email","id","label","natural_person","parent_applicant_id","reference_id","status","type","updated_at","workflow_session_id"],"title":"Natural Person Applicant","type":"object"},"Legal_Person_Applicant":{"additionalProperties":false,"description":"A legal person Applicant.","properties":{"id":{"description":"Unique identifier of the Applicant.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"description":"Unique identifier of the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"status":{"description":"Status of the Applicant.","enum":["initiated","notified","processed"],"example":"initiated","type":"string"},"label":{"description":"Label of the Applicant.","example":"Acme Corp","type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","example":"REF-12345","nullable":true,"type":"string"},"delivery_mode":{"default":"none","description":"Delivery mode to notify Applicants.","enum":["none","email"],"example":"email","type":"string"},"email":{"description":"Preferred email address for managing notifications, required if delivery_mode is set to email.","example":"applicant@example.com","format":"email","maxLength":100,"nullable":true,"type":"string"},"created_at":{"description":"Creation date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Last update date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"type":{"description":"Type of the Applicant.","enum":["legal_person"],"type":"string"},"legal_person":{"$ref":"#/components/schemas/LegalPerson"},"parent_applicant_id":{"description":"The id of the parent Applicant (should be a legal_person in the same Workflow Session), or null for a root / standalone Applicant.","format":"uuid","nullable":true,"type":"string","example":null},"child_applicant_ids":{"description":"The ids of the child Applicants; empty for a natural_person or a childless root.","example":[],"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["child_applicant_ids","created_at","delivery_mode","email","id","label","legal_person","parent_applicant_id","reference_id","status","type","updated_at","workflow_session_id"],"title":"Legal Person Applicant","type":"object"},"WorkflowSessionLinks_applicants_inner":{"additionalProperties":false,"properties":{"id":{"description":"Unique identifier of the Applicant.","example":"9a93d3b5-fb3b-4abf-9e70-26315b33506c","format":"uuid","type":"string"},"workflow_session_id":{"description":"Unique identifier of the Workflow Session.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"workflow_session_link_url":{"description":"URL of the portal link for this Applicant.","example":"https://portal.yousign.app/workflow_sessions/abc123","type":"string"},"workflow_session_link_expires_at":{"description":"Expiration date of the portal link.","example":"2024-01-25T22:59:00Z","format":"date-time","type":"string"},"status":{"description":"Status of the Applicant.","enum":["initiated","notified","processed"],"example":"notified","type":"string"},"label":{"description":"Label of the Applicant.","example":"John Doe","type":"string"},"reference_id":{"description":"Unique applicant identifier as registered on your side.","nullable":true,"type":"string","example":null},"created_at":{"description":"Creation date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"updated_at":{"description":"Last update date of the Applicant.","example":"2024-01-18T22:59:00Z","format":"date-time","type":"string"},"type":{"description":"Type of the Applicant.","enum":["natural_person","legal_person"],"example":"natural_person","type":"string"},"parent_applicant_id":{"description":"The id of the parent Applicant. Always null on this endpoint, since only root and standalone Applicants are returned; kept for contract symmetry with the other Applicant responses.","format":"uuid","nullable":true,"type":"string","example":null},"child_applicant_ids":{"description":"The ids of the child Applicants covered by this root Applicant's entry; empty for a natural_person or a childless root.","example":[],"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["child_applicant_ids","created_at","id","label","parent_applicant_id","reference_id","status","type","updated_at","workflow_session_id","workflow_session_link_expires_at","workflow_session_link_url"],"type":"object"},"ResolveWorkflowSessionAction_resource":{"properties":{"id":{"description":"Unique ID of the resource used in the Workflow Session Action.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"},"type":{"description":"The type of resource used in the Workflow Session Action.","enum":["bank_account_verification","bank_account_connection_verification","bank_account_lookup_verification","business_registration_certificate_document_analysis","company_certificate_document_analysis","company_verification","driver_licence_document_analysis","identity_document_verification","identity_video_verification","proof_of_address_verification","rne_certificate_document_analysis","social_security_document_analysis","temporary_vehicle_registration_document_analysis","vehicle_registration_document_analysis","watchlist_verification","auto_insurance_claims_history_document_analysis","payslip_document_analysis","invoice_document_analysis","tax_notice_document_analysis","proof_of_address_document_analysis","id_document_document_analysis","other_type_document_analysis"],"example":"bank_account_verification","type":"string"}},"required":["id","type"],"type":"object"},"WorkflowTemplate_action_groups_inner":{"properties":{"type":{"description":"Type of the Action Group.","enum":["signature_request","identity_verification","proof_of_address_verification","company_verification","watchlist_verification","bank_account_verification","document_analysis"],"example":"identity_verification","type":"string"}},"required":["type"],"type":"object"},"WorkflowTemplate_workspaces_inner":{"properties":{"id":{"description":"Unique identifier of the Workspace.","example":"0ef334d2-7f36-4643-8a2a-4283b4a3e4a4","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"Workspace_users_inner":{"properties":{"id":{"example":"89120884-d29a-4b1a-ac7b-a9e73a872795","format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"FraudRiskAnalysis_indicators_inner":{"additionalProperties":false,"properties":{"indicator":{"description":"Machine-readable identifier of the detected indicator.","example":"metadata.suspicious_producer","type":"string"},"type":{"description":"Type of the indicator.","example":"RISK","type":"string"},"category":{"description":"Category the indicator belongs to.","example":"metadata","type":"string"},"title":{"description":"Human-readable title of the indicator.","example":"Document processed by an editing tool","type":"string"},"description":{"description":"Human-readable description of the indicator.","example":"The document was produced by iLovePDF, a tool commonly used to edit or rework existing documents rather than to issue an original.","type":"string"}},"required":["category","description","indicator","title","type"],"type":"object"},"InitiateSocialSecurity_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"first_name":"John","last_name":"Doe"},"nullable":true,"properties":{"first_name":{"description":"Expected first name extracted from the document.","nullable":false,"type":"string"},"last_name":{"description":"Expected last name extracted from the document.","nullable":false,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"InitiateCompanyCertificate_checks_legal_representatives_inner":{"properties":{"first_name":{"description":"Expected first name extracted from the document.","nullable":false,"type":"string"},"last_name":{"description":"Expected last name extracted from the document.","nullable":false,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"InitiateCompanyCertificate_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"legal_representatives":[{"first_name":"John","last_name":"Doe"}]},"nullable":true,"properties":{"legal_representatives":{"description":"Expected list of legal representatives extracted from the document.","items":{"$ref":"#/components/schemas/InitiateCompanyCertificate_checks_legal_representatives_inner"},"type":"array"}},"required":["legal_representatives"],"type":"object"},"InitiateTemporaryVehicleRegistrationDocument_checks_vehicle_owner":{"description":"Expected vehicle owner information.","properties":{"type":{"description":"Type of the vehicle owner.","enum":["natural_person","legal_person"],"type":"string"},"first_name":{"description":"Expected first name of the vehicle owner.","nullable":false,"type":"string"},"last_name":{"description":"Expected last name of the vehicle owner.","nullable":false,"type":"string"},"company_name":{"description":"Expected company name of the vehicle owner. Required when type is `legal_person`.","nullable":false,"type":"string"}},"required":["type"],"type":"object"},"InitiateTemporaryVehicleRegistrationDocument_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"vehicle_owner":{"type":"natural_person","first_name":"John","last_name":"Doe"}},"nullable":true,"properties":{"vehicle_owner":{"$ref":"#/components/schemas/InitiateTemporaryVehicleRegistrationDocument_checks_vehicle_owner"}},"required":["vehicle_owner"],"type":"object"},"InitiateVehicleRegistrationDocument_checks_vehicle_owner":{"additionalProperties":false,"description":"Vehicle owner information to check against the document.","properties":{"type":{"description":"Type of the vehicle owner.","enum":["natural_person","legal_person"],"type":"string"},"first_name":{"description":"Expected first name of the vehicle owner. Required for natural persons.","nullable":true,"type":"string"},"last_name":{"description":"Expected last name of the vehicle owner. Required for natural persons.","nullable":true,"type":"string"},"company_name":{"description":"Expected company name of the vehicle owner. Required when type is `legal_person`.","nullable":true,"type":"string"}},"required":["first_name","last_name","type"],"type":"object"},"InitiateVehicleRegistrationDocument_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"vehicle_owner":{"type":"natural_person","first_name":"John","last_name":"Doe"}},"nullable":true,"properties":{"vehicle_owner":{"$ref":"#/components/schemas/InitiateVehicleRegistrationDocument_checks_vehicle_owner"}},"required":["vehicle_owner"],"type":"object"},"InitiateAutoInsuranceClaimsHistory_checks_policy_holder":{"description":"Expected policy holder information.","properties":{"type":{"description":"Type of the policy holder.","enum":["natural_person","legal_person"],"type":"string"},"first_name":{"description":"Expected first name of the policy holder.","nullable":false,"type":"string"},"last_name":{"description":"Expected last name of the policy holder.","nullable":false,"type":"string"},"company_name":{"description":"Expected company name of the policy holder.","nullable":false,"type":"string"}},"required":["type"],"type":"object"},"InitiateAutoInsuranceClaimsHistory_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"policy_holder":{"type":"natural_person","first_name":"John","last_name":"Doe"}},"nullable":true,"properties":{"policy_holder":{"$ref":"#/components/schemas/InitiateAutoInsuranceClaimsHistory_checks_policy_holder"}},"required":["policy_holder"],"type":"object"},"InitiateTaxNotice_checks_full_name_check":{"additionalProperties":false,"description":"Expected full name to check against the document.","properties":{"first_name":{"description":"Expected first name to check against the document.","nullable":false,"type":"string"},"last_name":{"description":"Expected last name to check against the document.","nullable":false,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"InitiateTaxNotice_checks_income_year_check":{"additionalProperties":false,"description":"Expected income year to check against the document.","properties":{"income_year":{"description":"Expected income year to check against the document.","pattern":"^[0-9]{4}$","type":"string"}},"required":["income_year"],"type":"object"},"InitiateTaxNotice_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"full_name_check":{"first_name":"John","last_name":"Doe"},"income_year_check":{"income_year":"2024"}},"nullable":true,"properties":{"full_name_check":{"$ref":"#/components/schemas/InitiateTaxNotice_checks_full_name_check"},"income_year_check":{"$ref":"#/components/schemas/InitiateTaxNotice_checks_income_year_check"}},"type":"object"},"InitiatePayslip_checks_full_name_check":{"additionalProperties":false,"description":"Expected full name to check against the document.","properties":{"first_name":{"description":"Expected first name to check against the document.","type":"string"},"last_name":{"description":"Expected last name to check against the document.","type":"string"}},"required":["first_name","last_name"],"type":"object"},"InitiatePayslip_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"full_name_check":{"first_name":"Marie","last_name":"Dupont"}},"nullable":true,"properties":{"full_name_check":{"$ref":"#/components/schemas/InitiatePayslip_checks_full_name_check"}},"type":"object"},"InitiateInvoice_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"buyer_name":"Acme SAS"},"nullable":true,"properties":{"buyer_name":{"description":"Expected buyer name to check against the document.\nThe name of the company in case of a legal person.\nThe full name of the individual in case of a natural person.\n","minLength":1,"type":"string"}},"required":["buyer_name"],"type":"object"},"InitiateProofOfAddress_1_checks":{"additionalProperties":false,"description":"Checks to perform on the document.","example":{"first_name":"Mario","last_name":"Rossi"},"nullable":true,"properties":{"first_name":{"description":"Expected first name of the certificate holder to check against the document.","minLength":1,"type":"string"},"last_name":{"description":"Expected last name of the certificate holder to check against the document.","minLength":1,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"InitiateFraudOnly_analysis_type":{"additionalProperties":false,"properties":{"extraction":{"description":"Must be `\"false\"` for a fraud-only analysis.","enum":["false"],"example":"false","type":"string"},"fraud_level":{"description":"Must be `advanced` for a fraud-only analysis.","enum":["advanced"],"example":"advanced","type":"string"}},"required":["extraction","fraud_level"],"type":"object"},"CompanyCertificateExtraction_legal_representatives_inner":{"properties":{"type":{"description":"Type of the legal representative extracted from the list of legal representatives in the document.","enum":["natural_person","legal_person"],"type":"string"},"function":{"description":"Function of the individual extracted from the list of legal representatives in the document.","nullable":true,"type":"string"},"first_name":{"description":"First name of the individual extracted from the list of legal representatives in the document.","nullable":true,"type":"string"},"last_name":{"description":"Last name of the individual extracted from the list of legal representatives in the document.","nullable":true,"type":"string"},"full_name":{"description":"Full name of the individual extracted from the list of legal representatives in the document.","nullable":true,"type":"string"},"company_name":{"description":"Company name extracted from the list of legal representatives in the document.","nullable":true,"type":"string"},"company_number":{"description":"Company number extracted from the list of legal representatives in the document.","nullable":true,"type":"string"}},"required":["company_name","company_number","first_name","full_name","function","last_name","type"],"type":"object"},"CompanyCertificateCheck_legal_representatives_inner":{"properties":{"full_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["full_name"],"type":"object"},"BusinessRegistrationCertificateExtraction_company_description":{"properties":{"active":{"description":"Indicates whether the company is active or not.","nullable":true,"type":"boolean"},"legal_form":{"description":"Legal form extracted from the document.","nullable":true,"type":"string"},"company_name":{"description":"Company name extracted from the document.","nullable":true,"type":"string"},"company_number":{"description":"Company number extracted from the document.","nullable":true,"type":"string"},"headquarter_company_number":{"description":"Headquarter company number extracted from the document.","nullable":true,"type":"string"},"first_name":{"description":"First name of the individual extracted from the document. Null if not a sole proprietor.","nullable":true,"type":"string"},"last_name":{"description":"Last name of the individual extracted from the document. Null if not a sole proprietor.","nullable":true,"type":"string"},"full_name":{"description":"Full name of the individual extracted from the document. Null if not a sole proprietor.","nullable":true,"type":"string"}},"required":["active","company_name","company_number","first_name","full_name","headquarter_company_number","last_name","legal_form"],"type":"object"},"BusinessRegistrationCertificateExtraction_branch_description":{"properties":{"address":{"description":"Address extracted from the document.","nullable":true,"type":"string"},"city":{"description":"City extracted from the document.","nullable":true,"type":"string"},"postal_code":{"description":"Postal code extracted from the document.","nullable":true,"type":"string"},"active":{"description":"Indicates whether the branch is active or not.","nullable":true,"type":"boolean"},"branch_company_number":{"description":"Branch company number extracted from the document.","nullable":true,"type":"string"}},"required":["active","address","branch_company_number","city","postal_code"],"type":"object"},"TemporaryVehicleRegistrationDocumentExtraction_vehicle_owner_information":{"description":"Vehicle owner information extracted from the document.","properties":{"vehicle_owner_full_name":{"description":"Full name of the vehicle owner extracted from the document.","nullable":true,"type":"string"},"vehicle_owner_birth_date":{"description":"Birth date of the vehicle owner extracted from the document.","nullable":true,"type":"string"},"vehicle_owner_address":{"description":"Address of the vehicle owner extracted from the document.","nullable":true,"type":"string"}},"required":["vehicle_owner_address","vehicle_owner_birth_date","vehicle_owner_full_name"],"type":"object"},"TemporaryVehicleRegistrationDocumentExtraction_document_recipient_information":{"description":"Document recipient information extracted from the document.","properties":{"document_recipient_full_name":{"description":"Full name of the document recipient extracted from the document.","nullable":true,"type":"string"},"document_recipient_address":{"description":"Address of the document recipient extracted from the document.","nullable":true,"type":"string"},"document_recipient_birth_date":{"description":"Birth date of the document recipient extracted from the document.","nullable":true,"type":"string"},"document_recipient_birth_city":{"description":"Birth city of the document recipient extracted from the document.","nullable":true,"type":"string"}},"required":["document_recipient_address","document_recipient_birth_city","document_recipient_birth_date","document_recipient_full_name"],"type":"object"},"TemporaryVehicleRegistrationDocumentCheck_vehicle_owner":{"additionalProperties":false,"description":"Check result for the vehicle owner.","properties":{"owner_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["owner_name"],"type":"object"},"FrenchVehicleRegistrationDocumentExtraction_owner_information":{"additionalProperties":false,"properties":{"owner_full_name":{"description":"Full name of the vehicle owner.","nullable":true,"type":"string"},"owner_address":{"description":"Address of the vehicle owner.","nullable":true,"type":"string"},"owner_type":{"description":"Type of the vehicle owner.","enum":["natural_person","legal_person"],"nullable":true,"type":"string"}},"required":["owner_address","owner_full_name","owner_type"],"type":"object"},"FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner":{"additionalProperties":false,"properties":{"co_owner_full_name":{"description":"Full name of the co-owner.","nullable":true,"type":"string"}},"required":["co_owner_full_name"],"type":"object"},"FrenchVehicleRegistrationDocumentExtraction_vehicle_information":{"additionalProperties":false,"properties":{"vehicle_brand":{"description":"Brand of the vehicle.","nullable":true,"type":"string"},"vehicle_version":{"description":"Version of the vehicle.","nullable":true,"type":"string"},"vehicle_model":{"description":"Model of the vehicle.","nullable":true,"type":"string"}},"required":["vehicle_brand","vehicle_model","vehicle_version"],"type":"object"},"FrenchVehicleRegistrationDocumentExtraction_vehicle_motor_information":{"additionalProperties":false,"properties":{"vehicle_fuel_type":{"description":"Type of fuel used by the vehicle.","nullable":true,"type":"string"},"vehicle_fiscal_power":{"description":"Fiscal power of the vehicle.","nullable":true,"type":"number"},"vehicle_max_power":{"description":"Maximum power of the vehicle engine.","nullable":true,"type":"number"},"vehicle_power":{"description":"Power of the vehicle engine.","nullable":true,"type":"number"}},"required":["vehicle_fiscal_power","vehicle_fuel_type","vehicle_max_power","vehicle_power"],"type":"object"},"ItalianVehicleRegistrationDocumentExtraction_owner_information":{"additionalProperties":false,"properties":{"owner_full_name":{"description":"Full name of the vehicle owner.","nullable":true,"type":"string"},"owner_address":{"description":"Address of the vehicle owner.","nullable":true,"type":"string"},"owner_type":{"description":"Type of the vehicle owner.","enum":["natural_person","legal_person"],"nullable":true,"type":"string"},"owner_birth_date":{"description":"Birth date of the vehicle owner.","format":"date","nullable":true,"type":"string"}},"required":["owner_address","owner_birth_date","owner_full_name","owner_type"],"type":"object"},"ItalianVehicleRegistrationDocumentExtraction_deed_informations_inner":{"additionalProperties":false,"properties":{"deed_date":{"description":"Date of the deed.","nullable":true,"type":"string"},"deed_type":{"description":"Type of the deed.","nullable":true,"type":"string"},"liens_encumbrances":{"description":"Liens or encumbrances on the vehicle.","nullable":true,"type":"string"},"previous_owner_full_name":{"description":"Full name of the previous owner.","nullable":true,"type":"string"}},"required":["deed_date","deed_type","liens_encumbrances","previous_owner_full_name"],"type":"object"},"ItalianVehicleRegistrationDocumentExtraction_vehicle_motor_information":{"additionalProperties":false,"properties":{"vehicle_fuel_type":{"description":"Type of fuel used by the vehicle.","nullable":true,"type":"string"},"vehicle_max_power":{"description":"Maximum power of the vehicle engine.","nullable":true,"type":"number"},"vehicle_displacement_type":{"description":"Displacement type of the vehicle engine.","nullable":true,"type":"number"}},"required":["vehicle_displacement_type","vehicle_fuel_type","vehicle_max_power"],"type":"object"},"AutoInsuranceClaimsHistoryExtraction_drivers_information_inner":{"additionalProperties":false,"properties":{"driver_full_name":{"description":"Full name of the driver.","nullable":true,"type":"string"},"driver_birth_date":{"description":"Birth date of the driver.","format":"date","nullable":true,"type":"string"},"coverage_start_date":{"description":"Start date of the driver's coverage.","format":"date","nullable":true,"type":"string"},"coverage_end_date":{"description":"End date of the driver's coverage, if applicable.","format":"date","nullable":true,"type":"string"},"driver_license_number":{"description":"License number of the driver.","nullable":true,"type":"string"},"driver_license_category":{"description":"License category of the driver.","nullable":true,"type":"string"},"driver_license_issuance_date":{"description":"Issuance date of the driver's license.","format":"date","nullable":true,"type":"string"}},"required":["coverage_end_date","coverage_start_date","driver_birth_date","driver_full_name","driver_license_category","driver_license_issuance_date","driver_license_number"],"type":"object"},"AutoInsuranceClaimsHistoryExtraction_incidents_information_inner":{"additionalProperties":false,"properties":{"incident_date":{"description":"Date of the incident.","format":"date","nullable":true,"type":"string"},"incident_description":{"description":"Description of the incident.","nullable":true,"type":"string"},"incident_type":{"description":"Type of the incident.","nullable":true,"type":"string"},"incident_responsability":{"description":"Responsibility level for the incident.","nullable":true,"type":"string"},"drivers_full_name":{"description":"Full name of the driver involved in the incident.","nullable":true,"type":"string"}},"required":["drivers_full_name","incident_date","incident_description","incident_responsability","incident_type"],"type":"object"},"AutoInsuranceClaimsHistoryCheck_policy_holder":{"additionalProperties":false,"description":"Check result for the policy holder.","properties":{"owner_name":{"$ref":"#/components/schemas/DocumentAnalysisCheck"}},"required":["owner_name"],"type":"object"},"FrenchTaxNoticeExtraction_2d_doc":{"additionalProperties":false,"description":"The 2D document extracted from the document.","nullable":false,"properties":{"full_name_1":{"description":"The holder full name of the first declarant extracted from the 2D document.","example":"Doe John","nullable":true,"type":"string"},"fiscal_number_1":{"description":"The fiscal number of the first declarant extracted from the 2D document.","example":"0312345678901","nullable":true,"type":"string"},"full_name_2":{"description":"The holder full name of the second declarant extracted from the 2D document.","example":"Doe Jane","nullable":true,"type":"string"},"fiscal_number_2":{"description":"The fiscal number of the second declarant extracted from the 2D document.","example":"0398765432109","nullable":true,"type":"string"},"tax_notice_reference":{"description":"The tax notice reference number extracted from the 2D document.","example":"2412B01234567","nullable":true,"type":"string"},"income_year":{"description":"Year of incomes (usually the year before document issuance) extracted from the 2D document.","example":2024,"nullable":true,"type":"integer"},"reference_income":{"description":"The fiscal reference income extracted from the 2D document.","example":30000,"nullable":true,"type":"integer"},"parts_count":{"description":"Number of parts in the household extracted from the 2D document.","example":1,"nullable":true,"type":"integer"}},"required":["fiscal_number_1","fiscal_number_2","full_name_1","full_name_2","income_year","parts_count","reference_income","tax_notice_reference"],"type":"object"},"TaxNoticeCheck_income_year":{"additionalProperties":false,"example":{"extracted":2024,"expected":2024,"match_level":"exact"},"properties":{"extracted":{"description":"The extracted value from the document.","nullable":true,"type":"integer"},"expected":{"description":"The expected value for the check.","type":"integer"},"match_level":{"$ref":"#/components/schemas/DocumentAnalysisMatchLevel"}},"required":["expected","extracted","match_level"],"type":"object"},"IdDocumentExtraction_address":{"additionalProperties":false,"description":"The address of the document holder, extracted from the document.","nullable":true,"properties":{"full_address":{"description":"The full address extracted from the document.","example":"Musterstraße 1, 10115 Berlin","nullable":true,"type":"string"},"handwritten":{"description":"Whether the address was detected as handwritten on the document.","example":false,"nullable":true,"type":"boolean"}},"required":["full_address","handwritten"],"type":"object"},"IdDocumentExtraction_mrz":{"additionalProperties":false,"description":"The Machine Readable Zone (MRZ) lines, extracted from the document.","nullable":true,"properties":{"line1":{"description":"The first line of the MRZ.","example":"IDD<<L01X00T479<<<<<<<<<<<<<<<","nullable":true,"type":"string"},"line2":{"description":"The second line of the MRZ.","example":"9001157M3003141D<<<<<<<<<<<<<<8","nullable":true,"type":"string"},"line3":{"description":"The third line of the MRZ.","example":"MUSTERMANN<<ERIKA<<<<<<<<<<<<<<","nullable":true,"type":"string"}},"required":["line1","line2","line3"],"type":"object"},"CreateElectronicSealFieldSealPayload_captions_inner":{"additionalProperties":false,"properties":{"text":{"description":"The caption text to display on the seal image.","maxLength":150,"type":"string"}},"required":["text"],"type":"object"},"SignatureRequest_SignerFromInfoInput_info":{"additionalProperties":false,"description":"Signer identity when creating from raw info.","properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Signer's first name.","example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Signer's last name.","example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"description":"Signer's email address.","format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale"],"type":"object"},"SignatureRequest_SignerFromInfoInput_redirect_urls":{"additionalProperties":false,"properties":{"success":{"description":"URL the Signer is redirected to after a successful signature.","example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"description":"URL the Signer is redirected to after a signature error.","example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_SignerFromInfoInput_custom_text":{"additionalProperties":false,"properties":{"request_subject":{"description":"Custom subject of the signature request email.","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"description":"Custom body of the signature request email.","maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"description":"Custom subject of reminder emails.","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"description":"Custom body of reminder emails.","maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_EmailNotification_custom_text":{"additionalProperties":false,"nullable":true,"properties":{"request_subject":{"description":"Custom subject of the signature request email.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"description":"Custom body of the signature request email.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"description":"Custom subject of reminder emails.","format":"safe-string","maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"description":"Custom body of reminder emails.","format":"safe-string","maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_EmbeddedPreparation_redirect_urls":{"additionalProperties":false,"description":"Redirect URLs for the Embedded Preparation navigation buttons.\nOn `PATCH`, an omitted URL is left unchanged and an explicit `null` clears it.\n","nullable":true,"properties":{"done":{"description":"URL the end-user is redirected to after clicking `Done`. If omitted, the default success screen is shown.","example":"https://example.com/done","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"back":{"description":"URL the end-user is redirected to after clicking `Back`. The `Back` button is shown only when this URL is set and its display setting is on.","example":"https://example.com/back","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info":{"additionalProperties":false,"description":"Create new signer","properties":{"first_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Substitute Signer's first name.","example":"John","maxLength":255,"minLength":1,"type":"string"},"last_name":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Substitute Signer's last name.","example":"Doe","maxLength":255,"minLength":1,"type":"string"},"email":{"description":"Substitute Signer's email address.","format":"email","maxLength":100,"minLength":1,"type":"string"},"phone_number":{"description":"E.164 format. Becomes mandatory if `signature_authentication_mode` requires a phone number.","example":"+41446667700","minLength":1,"nullable":true,"type":"string"},"locale":{"$ref":"#/components/schemas/Locale"}},"required":["email","first_name","last_name","locale"],"type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls":{"additionalProperties":false,"properties":{"success":{"description":"URL the Signer is redirected to after a successful signature.","example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"description":"URL the Signer is redirected to after a signature error.","example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"decline":{"description":"URL the Signer is redirected to after declining.","example":"https://example.com/decline","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput_redirect_urls":{"additionalProperties":false,"properties":{"success":{"example":"https://example.com/success","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"error":{"example":"https://example.com/error","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"},"decline":{"example":"https://example.com/decline","format":"uri","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput_custom_text":{"additionalProperties":false,"properties":{"request_subject":{"maxLength":512,"minLength":1,"nullable":true,"type":"string"},"request_body":{"maxLength":2000,"minLength":1,"nullable":true,"type":"string"},"reminder_subject":{"maxLength":512,"minLength":1,"nullable":true,"type":"string"},"reminder_body":{"maxLength":2000,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"SignatureDisplay_oneOf":{"properties":{"layout":{"description":"• `minimal` (default): Only shows the signer’s signature visual.\n• `detailed`: Adds extra detail to the signature field, including the signer’s full name, email, and the date of signature.\n","enum":["minimal","legacy"],"type":"string"}},"required":["layout"],"type":"object"},"SignatureDisplay_oneOf_1_options":{"description":"Only applicable when `display.layout = detailed`.","properties":{"date_format":{"$ref":"#/components/schemas/CreateFieldDateFormat"},"time_format":{"$ref":"#/components/schemas/CreateFieldTimeFormat"},"show_timezone":{"default":false,"description":"Boolean indicating whether to display the timezone abbreviation (e.g., `CEST`) next to the time.","nullable":true,"type":"boolean"},"show_email":{"default":true,"description":"Boolean indicating whether to display the signer's email address.","nullable":false,"type":"boolean"}},"type":"object"},"SignatureDisplay_oneOf_1":{"properties":{"layout":{"description":"• `minimal` (default): Only shows the signer’s signature visual.\n• `detailed`: Adds extra detail to the signature field, including the signer’s full name, email, and the date of signature.\n","enum":["detailed"],"type":"string"},"options":{"$ref":"#/components/schemas/SignatureDisplay_oneOf_1_options"}},"required":["layout","options"],"type":"object"},"Minimal_layout":{"properties":{"layout":{"description":"`minimal` (default): Only shows the signer’s signature visual.\n`detailed`: Adds extra detail to the signature field, including the signer’s full name, email, and the date of signature.\n","enum":["minimal"],"type":"string"}},"required":["layout"],"title":"Minimal layout","type":"object"},"Detailed_layout":{"example":{"layout":"detailed","options":{"date_format":"dd/MM/yyyy","time_format":"HH:mm","show_timezone":true,"show_email":false}},"properties":{"layout":{"description":"`minimal` (default): Only shows the signer’s signature visual.\n`detailed`: Adds extra detail to the signature field, including the signer’s full name, email, and the date of signature.\n","enum":["detailed"],"type":"string"},"options":{"$ref":"#/components/schemas/SignatureDisplay_oneOf_1_options"}},"required":["layout","options"],"title":"Detailed layout","type":"object"},"Signature_2":{"properties":{"document_id":{"description":"Identifier of the Document the signature Field is placed on.","example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"description":"Field type discriminator.","enum":["signature"],"type":"string"},"page":{"description":"Page number where the Field is placed.","format":"int32","minimum":1,"type":"integer"},"x":{"description":"Horizontal position (points from left).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"description":"Vertical position (points from top).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"height":{"description":"Height of the signature Field in points (default 37).","format":"int32","maximum":1000,"minimum":37,"type":"integer"},"width":{"description":"Width of the signature Field in points (default 85).","format":"int32","maximum":2000,"minimum":85,"type":"integer"},"reason":{"allOf":[{"$ref":"#/components/schemas/HumanName"}],"description":"Provide extra context to explain why the Document is being signed. Once the Document is signed, the custom reason is stored in the Audit Trail and is included in the signature certificate.\nThe default value is: \"Signed by [Signer first name] [Signer last name]\".\n","example":"Signed by John Doe","maxLength":150,"nullable":true,"type":"string"}},"required":["document_id","page","type","x","y"],"title":"Signature","type":"object"},"Mention_2":{"properties":{"document_id":{"description":"Identifier of the Document the mention Field is placed on.","example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"description":"Field type discriminator.","enum":["mention"],"type":"string"},"page":{"description":"Page number where the Field is placed.","format":"int32","minimum":1,"type":"integer"},"x":{"description":"Horizontal position (points from left).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"description":"Vertical position (points from top).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the mention length","format":"int32","minimum":24,"type":"integer"},"height":{"description":"The height must be 24 or a multiple of 15 greater than 24. If height is not provided, it will be calculated depending on the number of newlines in the mention","example":150,"format":"int32","minimum":24,"nullable":true,"type":"integer"},"mention":{"description":"Text of the mention displayed on the Document.","format":"safe-string","type":"string"},"name":{"description":"Name of the Field.","example":"Job Title","maxLength":128,"minLength":1,"nullable":true,"type":"string"}},"required":["document_id","mention","page","type","x","y"],"title":"Mention","type":"object"},"Text_2":{"properties":{"document_id":{"description":"Identifier of the Document the text Field is placed on.","example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"description":"Field type discriminator.","enum":["text"],"type":"string"},"page":{"description":"Page number where the Field is placed.","format":"int32","minimum":1,"type":"integer"},"x":{"description":"Horizontal position (points from left).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"description":"Vertical position (points from top).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"width":{"description":"If not set, the width is automatically calculated with the max_length value","example":90,"format":"int32","minimum":24,"type":"integer"},"height":{"description":"The height must be 24 or a multiple of 15 greater than 24.","example":150,"format":"int32","minimum":24,"type":"integer"},"max_length":{"description":"Maximum number of characters the Signer can enter.","maximum":32767,"minimum":1,"type":"integer"},"question":{"description":"Question/label shown to the Signer for this text Field.","example":"What is your job title?","maxLength":255,"type":"string"},"instruction":{"description":"Additional instruction shown to the Signer.","example":"Your position in the company","nullable":true,"type":"string"},"optional":{"description":"Whether filling this Field is optional.","type":"boolean"},"name":{"description":"Name of the Field.","example":"Job Title","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"default_value":{"description":"If a default value is provided, the Field will be pre-filled with this value. The Signer can modify it before signing unless the Field is set to `read-only`.","example":"Software Engineer","maxLength":32767,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the Signer cannot modify the Field and the default value (if provided) will remain unchanged.","type":"boolean"}},"required":["document_id","max_length","optional","page","question","type","x","y"],"title":"Text","type":"object"},"Checkbox_2":{"properties":{"document_id":{"description":"Identifier of the Document the checkbox Field is placed on.","example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"description":"Field type discriminator.","enum":["checkbox"],"type":"string"},"page":{"description":"Page number where the Field is placed.","format":"int32","minimum":1,"type":"integer"},"x":{"description":"Horizontal position (points from left).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"description":"Vertical position (points from top).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"size":{"description":"The omission of size parameter is considered as deprecated. The size determines both the width and height of the checkbox.","format":"int32","maximum":240,"minimum":8,"type":"integer"},"optional":{"description":"Whether ticking this checkbox is optional.","type":"boolean"},"name":{"description":"Name of the checkbox Field.","example":"Checkbox 1","nullable":true,"type":"string"},"checked":{"description":"Current checked state of the checkbox.","type":"boolean"},"default_checked":{"description":"Whether the checkbox is initially checked.","type":"boolean"},"read_only":{"default":false,"description":"If set to `true`, the checkbox cannot be modified by the signer.","type":"boolean"}},"required":["checked","document_id","optional","page","type","x","y"],"title":"Checkbox","type":"object"},"RadioGroup_2_radios_inner":{"properties":{"name":{"description":"Radio button's name","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"x":{"description":"Horizontal position of the radio (points from left).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"y":{"description":"Vertical position of the radio (points from top).","format":"int32","maximum":32767,"minimum":0,"type":"integer"},"size":{"description":"Size (width and height) of the radio in points.","format":"int32","maximum":240,"minimum":8,"type":"integer"},"default_checked":{"default":false,"description":"Indicates whether the radio is initially checked (`true`) or unchecked (`false`).","type":"boolean"}},"required":["x","y"],"type":"object"},"RadioGroup_2":{"properties":{"document_id":{"description":"Identifier of the Document the radio group Field is placed on.","example":"9b6ed2f3-244f-487a-baa1-bbe4f51c8748","format":"uuid","type":"string"},"type":{"description":"Field type discriminator.","enum":["radio_group"],"type":"string"},"page":{"description":"Page number where the Field is placed.","format":"int32","minimum":1,"type":"integer"},"optional":{"description":"Whether selecting a radio is optional.","type":"boolean"},"name":{"description":"Radio group's name","example":"radio_group_name_1","maxLength":128,"minLength":1,"nullable":true,"type":"string"},"read_only":{"default":false,"description":"If set to `true`, the radio button cannot be modified by the Signer.","type":"boolean"},"radios":{"description":"List of radio buttons in the group.","items":{"$ref":"#/components/schemas/RadioGroup_2_radios_inner"},"type":"array"}},"required":["document_id","optional","page","radios","type"],"title":"RadioGroup","type":"object"},"OTP_Message":{"properties":{"custom_text":{"description":"Custom text contained is the one-time password SMS sent to the Signer. This feature is available from SCALE plan, and disabled by default. Please contact [customer support](https://yousign.app/auth/workspace/help) to request an activation. This value is a string composed of GSM characters supported by 7-bit encoding, must contain \"{code}\", the length must be less than 105 and cannot contain URL, email, phone number and IP address.\\\nThis property is a [Safe String](https://developers.youtrust.com/reference/oas-specification#safe-string).\n","format":"safe-string","minLength":1,"type":"string"}},"required":["custom_text"],"title":"OTP Message","type":"object"}},"securitySchemes":{"bearerAuth":{"scheme":"bearer","type":"http"}}}}