{"openapi":"3.1.0","info":{"title":"CoreSign API","version":"1","description":"Prepare documents for signature, follow them and download their sealed records. An API key or an agent PREPARES; only a signed-in person SENDS, from the CoreSign console. The full reference, with examples: /api-reference."},"paths":{"/api/v1/envelope/create":{"post":{"tags":["v1"],"summary":"Create Envelope","operationId":"create_envelope_api_v1_envelope_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnvelopeSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/create-from-template":{"post":{"tags":["v1"],"summary":"Create From Template","operationId":"create_from_template_api_v1_envelope_create_from_template_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFromTemplateSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional: 1 to 255 visible characters, no spaces, one per envelope you mean to make. A retry with the same key and body within 24 hours answers 200 with the envelope the first request made (replayed: true); the same key with another body is 409. An empty or malformed key is refused 400. Without the header there is no idempotency: a retry can make a second draft.","schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[!-~]+$"}}]}},"/api/v1/envelope/send":{"post":{"tags":["v1"],"summary":"Send Envelope","operationId":"send_envelope_api_v1_envelope_send_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEnvelopeSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/delete":{"post":{"tags":["v1"],"summary":"Delete Envelope","operationId":"delete_envelope_api_v1_envelope_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEnvelopeSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A client's key deletes only a draft that client prepared; a test key, only a test envelope.","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/reject-draft":{"post":{"tags":["v1"],"summary":"Reject Draft","operationId":"reject_draft_api_v1_envelope_reject_draft_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectDraftSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/void":{"post":{"tags":["v1"],"summary":"Void Envelope","operationId":"void_envelope_api_v1_envelope_void_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidEnvelopeSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/certificate/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Certificate Pdf","operationId":"get_certificate_pdf_api_v1_envelope_certificate__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/certificate-record/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Certificate Record","operationId":"get_certificate_record_api_v1_envelope_certificate_record__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/signed-document/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Signed Document","operationId":"get_signed_document_api_v1_envelope_signed_document__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/sealed-payload/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Sealed Payload","operationId":"get_sealed_payload_api_v1_envelope_sealed_payload__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/resend-verification":{"post":{"tags":["v1"],"summary":"Resend Verification","operationId":"resend_verification_api_v1_envelope_resend_verification_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEnvelopeSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/reminders":{"post":{"tags":["v1"],"summary":"Set Envelope Reminders","operationId":"set_envelope_reminders_api_v1_envelope_reminders_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemindersSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Not callable with an API key or by an agent: a signed-in person does this in the CoreSign console. A client's key is answered 403 client_route_not_allowed, a test key 403 test_key_route_not_allowed. Documented so an integration knows where its draft goes.","x-coresign-access":"session","security":[]}},"/api/v1/envelope/verify-seal/{envelope_id}":{"get":{"tags":["v1"],"summary":"Verify Envelope Seal","operationId":"verify_envelope_seal_api_v1_envelope_verify_seal__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Public: no key needed.","x-coresign-access":"public","security":[]}},"/api/v1/envelope/verify-document":{"post":{"tags":["v1"],"summary":"Verify Document","operationId":"verify_document_api_v1_envelope_verify_document_post","requestBody":{"content":{"application/json":{"schema":{"title":"Body"}}}},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Public: no key needed.","x-coresign-access":"public","security":[]}},"/api/v1/envelope/status/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Envelope Status","operationId":"get_envelope_status_api_v1_envelope_status__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/audit/{envelope_id}":{"get":{"tags":["v1"],"summary":"Get Audit Trail","operationId":"get_audit_trail_api_v1_envelope_audit__envelope_id__get","parameters":[{"name":"envelope_id","in":"path","required":true,"schema":{"type":"string","title":"Envelope Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/envelope/list":{"get":{"tags":["v1"],"summary":"List Envelopes","operationId":"list_envelopes_api_v1_envelope_list_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}},{"name":"client_profile_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Profile Id"}},{"name":"mine","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mine"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/disclosure/{version}":{"get":{"tags":["v1"],"summary":"Get Disclosure","operationId":"get_disclosure_api_v1_disclosure__version__get","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","title":"Version"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Public: no key needed.","x-coresign-access":"public","security":[]}},"/api/v1/terms/{version}":{"get":{"tags":["v1"],"summary":"Get Terms","operationId":"get_terms_api_v1_terms__version__get","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","title":"Version"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Public: no key needed.","x-coresign-access":"public","security":[]}},"/api/v1/templates/upload":{"post":{"tags":["templates"],"summary":"Upload Template","operationId":"upload_template_api_v1_templates_upload_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_template_api_v1_templates_upload_post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates":{"get":{"tags":["templates"],"summary":"List Templates","operationId":"list_templates_api_v1_templates_get","responses":{"200":{"content":{"application/json":{"schema":{}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}":{"get":{"tags":["templates"],"summary":"Get Template","operationId":"get_template_api_v1_templates__template_id__get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]},"delete":{"tags":["templates"],"summary":"Delete Template","operationId":"delete_template_api_v1_templates__template_id__delete","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A client's key is answered 403 client_route_not_allowed: a person in the console deletes a template, and a test key one a test key made (on any other, 403 test_key_template_not_its_own).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}/pages/{page_index}":{"get":{"tags":["templates"],"summary":"Get Page Image","operationId":"get_page_image_api_v1_templates__template_id__pages__page_index__get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}},{"name":"page_index","in":"path","required":true,"schema":{"type":"integer","title":"Page Index"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}/suggested-fields":{"get":{"tags":["templates"],"summary":"Suggested Fields","operationId":"suggested_fields_api_v1_templates__template_id__suggested_fields_get","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}/fields":{"post":{"tags":["templates"],"summary":"Add Field","operationId":"add_field_api_v1_templates__template_id__fields_post","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFieldSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A test key changes only a template a test key made (is_test); on any other it is answered 403 test_key_template_not_its_own.","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}/fields/{field_id}":{"put":{"tags":["templates"],"summary":"Update Field","operationId":"update_field_api_v1_templates__template_id__fields__field_id__put","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}},{"name":"field_id","in":"path","required":true,"schema":{"type":"string","title":"Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldSchema"}}}},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A test key changes only a template a test key made (is_test); on any other it is answered 403 test_key_template_not_its_own.","x-coresign-access":"key","security":[{"apiKey":[]}]},"delete":{"tags":["templates"],"summary":"Delete Field","operationId":"delete_field_api_v1_templates__template_id__fields__field_id__delete","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}},{"name":"field_id","in":"path","required":true,"schema":{"type":"string","title":"Field Id"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A test key changes only a template a test key made (is_test); on any other it is answered 403 test_key_template_not_its_own.","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/{template_id}/fields/batch":{"post":{"tags":["templates"],"summary":"Batch Update Fields","operationId":"batch_update_fields_api_v1_templates__template_id__fields_batch_post","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","title":"Template Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AddFieldSchema"},"maxItems":500,"title":"Fields"}}}},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds). A test key changes only a template a test key made (is_test); on any other it is answered 403 test_key_template_not_its_own.","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/auth/me":{"get":{"tags":["auth"],"summary":"Whoami","operationId":"whoami_api_v1_auth_me_get","responses":{"200":{"content":{"application/json":{"schema":{}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/templates/from-text":{"post":{"tags":["templates"],"summary":"Template From Text","operationId":"template_from_text_api_v1_templates_from_text_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FromTextSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{}}}},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"description":"Call with an API key (Authorization: Bearer): a registered client's key, or a test key, which reaches test envelopes only. A live key must belong to a client registered at /settings/agents; a client set to require signed requests must also sign each one. Each answer carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset (Unix seconds) for the key's request limit; a 429 carries Retry-After (seconds).","x-coresign-access":"key","security":[{"apiKey":[]}]}},"/api/v1/verification-key":{"get":{"summary":"Verification Key","operationId":"verification_key_api_v1_verification_key_get","responses":{"200":{"content":{"application/json":{"schema":{}}}}},"description":"Public: no key needed.","x-coresign-access":"public","security":[]}}},"components":{"schemas":{"AddFieldSchema":{"properties":{"page_index":{"type":"integer","minimum":0.0,"title":"Page Index","default":0},"field_type":{"type":"string","title":"Field Type","default":"signature"},"field_label":{"type":"string","title":"Field Label","default":""},"x_percent":{"type":"number","maximum":100.0,"minimum":0.0,"title":"X Percent","default":0},"y_percent":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Y Percent","default":0},"width_percent":{"type":"number","maximum":100.0,"minimum":1.0,"title":"Width Percent","default":30},"height_percent":{"type":"number","maximum":100.0,"minimum":0.5,"title":"Height Percent","default":10},"assigned_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assigned To"},"required":{"type":"boolean","title":"Required","default":true}},"type":"object","title":"AddFieldSchema"},"Body_upload_template_api_v1_templates_upload_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["file"],"title":"Body_upload_template_api_v1_templates_upload_post"},"CreateEnvelopeSchema":{"properties":{"document_name":{"type":"string","title":"Document Name"},"document_content":{"additionalProperties":true,"type":"object","title":"Document Content"},"signers":{"items":{"$ref":"#/components/schemas/SignerSchema"},"type":"array","maxItems":25,"minItems":1,"title":"Signers"},"sender_name":{"type":"string","title":"Sender Name","default":""},"sender_email":{"type":"string","title":"Sender Email","default":""},"message":{"type":"string","title":"Message","default":"Please review and sign this document"},"expire_days":{"type":"integer","maximum":3650.0,"minimum":1.0,"title":"Expire Days","default":7},"brand_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand Name"},"brand_color":{"type":"string","title":"Brand Color","default":"#1B5E20"},"reminders":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reminders"}},"type":"object","required":["document_name","document_content","signers"],"title":"CreateEnvelopeSchema"},"CreateFromTemplateSchema":{"properties":{"template_id":{"type":"string","title":"Template Id"},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Name"},"signers":{"items":{"$ref":"#/components/schemas/SignerSchema"},"type":"array","maxItems":25,"minItems":1,"title":"Signers"},"field_mapping":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Field Mapping"},"sender_name":{"type":"string","title":"Sender Name","default":""},"sender_email":{"type":"string","title":"Sender Email","default":""},"message":{"type":"string","title":"Message","default":"Please review and sign this document"},"expire_days":{"type":"integer","maximum":3650.0,"minimum":1.0,"title":"Expire Days","default":7},"brand_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand Name"},"reminders":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reminders"},"client_profile_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Client Profile Id"}},"type":"object","required":["template_id","signers"],"title":"CreateFromTemplateSchema"},"DeleteEnvelopeSchema":{"properties":{"envelope_id":{"type":"string","title":"Envelope Id"}},"type":"object","required":["envelope_id"],"title":"DeleteEnvelopeSchema"},"FromTextSchema":{"properties":{"name":{"type":"string","title":"Name"},"text":{"type":"string","title":"Text"},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["name","text"],"title":"FromTextSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"RejectDraftSchema":{"properties":{"envelope_id":{"type":"string","title":"Envelope Id"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["envelope_id","reason"],"title":"RejectDraftSchema"},"RemindersSchema":{"properties":{"envelope_id":{"type":"string","title":"Envelope Id"},"on":{"type":"boolean","title":"On"}},"type":"object","required":["envelope_id","on"],"title":"RemindersSchema"},"SendEnvelopeSchema":{"properties":{"envelope_id":{"type":"string","title":"Envelope Id"}},"type":"object","required":["envelope_id"],"title":"SendEnvelopeSchema"},"SignerSchema":{"properties":{"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name","default":""},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order"}},"type":"object","required":["email"],"title":"SignerSchema"},"UpdateFieldSchema":{"properties":{"page_index":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Page Index"},"field_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Type"},"field_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field Label"},"x_percent":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"X Percent"},"y_percent":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Y Percent"},"width_percent":{"anyOf":[{"type":"number","maximum":100.0,"minimum":1.0},{"type":"null"}],"title":"Width Percent"},"height_percent":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.5},{"type":"null"}],"title":"Height Percent"},"assigned_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assigned To"},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required"}},"type":"object","title":"UpdateFieldSchema"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VoidEnvelopeSchema":{"properties":{"envelope_id":{"type":"string","title":"Envelope Id"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["envelope_id","reason"],"title":"VoidEnvelopeSchema"}},"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"csk_ API key"}}},"servers":[{"url":"https://sign.coresignapp.com"}]}