{"openapi":"3.1.0","info":{"title":"Yousign (BYOK) API","version":"0.1.0","description":"Yousign (BYOK) lets an AI assistant read your own Yousign data through the Yousign API with a key you supply (Yousign API key (production)). Read-only: 9 tools (list_signature_requests, get_signature_request, list_templates, list_labels, list_workspaces, list_company_verifications, list_custom_properties, list_workflow_templates, list_webhooks). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-yousign.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-yousign/docs"},"termsOfService":"https://connectorbay.com/byok-yousign/terms"},"servers":[{"url":"https://byok-yousign.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-yousign/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_signature_requests":{"post":{"operationId":"list_signature_requests","summary":"List signature requests (only those created through the public API unless a source is given) with status, dates, source ","description":"List signature requests (only those created through the public API unless a source is given) with status, dates, source and workspace; signer and sender details are not returned. Up to 100 per page. Use for \"Which Yousign signature requests are still ongoing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["draft","ongoing","done","deleted","expired","canceled","approval","rejected","declined","paused"],"type":"string"},{"type":"null"}],"default":null,"description":"Only requests in this status: draft, ongoing, done, deleted, expired, canceled, approval, rejected, declined or paused.","title":"Status"},"source":{"anyOf":[{"enum":["app","public_api","hubspot_integration","connector_salesforce_api","connector_google_api","connector_zapier_api"],"type":"string"},{"type":"null"}],"default":null,"description":"Request origin: app, public_api and others; the default returns public_api only.","title":"Source"},"created_after":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests created after this date (YYYY-MM-DD).","title":"Created After"},"created_before":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests created before this date (YYYY-MM-DD).","title":"Created Before"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests of this workspace ID.","title":"Workspace Id"},"external_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the request with this external ID.","title":"External Id"},"q":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search on the request name.","title":"Q"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the meta.next_cursor value from the previous answer.","title":"After"}},"title":"list_signature_requestsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_signature_request":{"post":{"operationId":"get_signature_request","summary":"Get one signature request: name, status, delivery mode, dates, source, workspace and ordering flags; signers and documen","description":"Get one signature request: name, status, delivery mode, dates, source, workspace and ordering flags; signers and documents are separate calls. Use for \"What is the status of Yousign signature request 2f0c\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"signature_request_id":{"description":"Signature request ID (UUID) from list_signature_requests.","maxLength":200,"title":"Signature Request Id","type":"string"}},"required":["signature_request_id"],"title":"get_signature_requestArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_templates":{"post":{"operationId":"list_templates","summary":"List signature request templates with name, description, draft or active status and workspace (10 per page at most). Use","description":"List signature request templates with name, description, draft or active status and workspace (10 per page at most). Use for \"Which Yousign templates do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":10,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 10).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the meta.next_cursor value from the previous answer.","title":"After"}},"title":"list_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_labels":{"post":{"operationId":"list_labels","summary":"List the labels that can categorise signature requests. Use for \"What labels do we use on Yousign requests\".","description":"List the labels that can categorise signature requests. Use for \"What labels do we use on Yousign requests\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only labels with this exact name.","title":"Name"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the meta.next_cursor value from the previous answer.","title":"After"}},"title":"list_labelsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspaces":{"post":{"operationId":"list_workspaces","summary":"List workspaces with name, default flag and dates; member lists are not returned. Use for \"Which Yousign workspaces exis","description":"List workspaces with name, default flag and dates; member lists are not returned. Use for \"Which Yousign workspaces exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the meta.next_cursor value from the previous answer.","title":"After"}},"title":"list_workspacesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_company_verifications":{"post":{"operationId":"list_company_verifications","summary":"List company verification records (pending, awaiting_data, verified, failed or inconclusive) with workspace and dates; a","description":"List company verification records (pending, awaiting_data, verified, failed or inconclusive) with workspace and dates; applicant data is not returned. Use for \"Which company verifications are still pending in Yousign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"status":{"anyOf":[{"enum":["pending","awaiting_data","verified","failed","inconclusive"],"type":"string"},{"type":"null"}],"default":null,"description":"Only verifications with this status.","title":"Status"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only verifications of this workspace ID.","title":"Workspace Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the meta.next_cursor value from the previous answer.","title":"After"}},"title":"list_company_verificationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_custom_properties":{"post":{"operationId":"list_custom_properties","summary":"List the organization's custom properties (text or list type) that can be attached to signature requests. Use for \"Which","description":"List the organization's custom properties (text or list type) that can be attached to signature requests. Use for \"Which custom properties are defined in Yousign\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["text","list"],"type":"string"},{"type":"null"}],"default":null,"description":"Property type: text or list.","title":"Type"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only properties applicable to this workspace ID.","title":"Workspace Id"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: the next_cursor value from the previous answer.","title":"After"}},"title":"list_custom_propertiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workflow_templates":{"post":{"operationId":"list_workflow_templates","summary":"List workflow templates (identity and document verification flows) with name and workspaces. Use for \"Which Yousign work","description":"List workflow templates (identity and document verification flows) with name and workspaces. Use for \"Which Yousign workflow templates exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_workflow_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_webhooks":{"post":{"operationId":"list_webhooks","summary":"List webhook subscriptions with endpoint, description, subscribed events and enabled flag; the signing secret is not ret","description":"List webhook subscriptions with endpoint, description, subscribed events and enabled flag; the signing secret is not returned. Use for \"Which Yousign webhooks are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}