{"openapi":"3.1.0","info":{"title":"Signdeer Server API","version":"1","description":"Server-to-server access to published forms, cases, workflow state, documents, and intake."},"x-signdeer-generated-from":"organization API routes","servers":[{"url":"https:\/\/signdeer.com\/api\/v1"}],"security":[{"bearerAuth":[]}],"paths":{"\/org\/ping":{"get":{"summary":"Verify the token and organization","responses":{"200":{"description":"Token is valid."}}}},"\/org\/forms":{"get":{"summary":"List published forms","responses":{"200":{"description":"Published forms and their customer-facing URLs.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FormsResponse"}}}}}}},"\/cases":{"get":{"summary":"List cases","parameters":[{"name":"status","in":"query","schema":{"type":"string"}},{"name":"source","in":"query","schema":{"type":"string"}},{"name":"party_name","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Paginated case summaries.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CaseListResponse"}}}}},"operationId":"api.v1.cases.index"},"post":{"summary":"Create a customer case","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateCaseRequest"}}}},"responses":{"201":{"description":"Case created with a customer URL.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CaseSummary"}}}},"422":{"description":"Validation or unpublished template."}},"operationId":"api.v1.cases.store"}},"\/cases\/{caseId}":{"parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Read a case and workflow state","responses":{"200":{"description":"Case detail.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CaseDetail"}}}}},"operationId":"api.v1.cases.show"},"patch":{"summary":"Update case metadata","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpdateCaseRequest"}}}},"responses":{"200":{"description":"Updated case summary."}},"operationId":"api.v1.cases.update"}},"\/cases\/{caseId}\/activity":{"parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Read the case activity timeline","responses":{"200":{"description":"Activity events."}},"operationId":"api.v1.cases.activity"}},"\/cases\/{caseId}\/documents":{"parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List case documents","responses":{"200":{"description":"Document metadata."}},"operationId":"api.v1.cases.documents"}},"\/cases\/{caseId}\/generated-files":{"parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List generated files","responses":{"200":{"description":"Generated-file metadata and status."}},"operationId":"api.v1.cases.generated-files"}},"\/cases\/{caseId}\/generated-files\/generate":{"parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"post":{"summary":"Queue generated-file creation","responses":{"202":{"description":"Generation queued."}},"operationId":"api.v1.cases.generate"}},"\/intake":{"get":{"summary":"List intake items","responses":{"200":{"description":"Paginated intake items."}},"operationId":"api.v1.intake.index"},"post":{"summary":"Create an intake item","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IntakeRequest"}}}},"responses":{"201":{"description":"Intake item created."}},"operationId":"api.v1.intake.store"}},"\/stats\/overview":{"get":{"operationId":"api.v1.stats.overview","summary":"Overview","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/stats\/cases":{"get":{"operationId":"api.v1.stats.cases","summary":"Cases","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/comments":{"post":{"operationId":"api.v1.cases.comments","summary":"Comments","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/assign":{"post":{"operationId":"api.v1.cases.assign","summary":"Assign","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms":{"get":{"operationId":"api.v1.cases.forms.index","summary":"Index","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms\/{formId}":{"get":{"operationId":"api.v1.cases.forms.show","summary":"Show","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms\/{formId}\/staff-data":{"post":{"operationId":"api.v1.cases.forms.staff-data","summary":"Staff Data","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/queues\/ekyc":{"get":{"operationId":"api.v1.queues.ekyc","summary":"Ekyc","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/ekyc":{"get":{"operationId":"api.v1.cases.ekyc","summary":"Ekyc","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/ekyc\/reviews\/{reviewId}\/verify":{"post":{"operationId":"api.v1.cases.ekyc.verify","summary":"Verify","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/ekyc\/reviews\/{reviewId}\/reject":{"post":{"operationId":"api.v1.cases.ekyc.reject","summary":"Reject","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/ekyc\/reviews\/{reviewId}\/escalate":{"post":{"operationId":"api.v1.cases.ekyc.escalate","summary":"Escalate","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"reviewId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/queues\/corrections":{"get":{"operationId":"api.v1.queues.corrections","summary":"Corrections","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/corrections":{"get":{"operationId":"api.v1.cases.corrections.index","summary":"Index","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}},"post":{"operationId":"api.v1.cases.corrections.store","summary":"Store","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/corrections\/{correctionId}\/resolve":{"post":{"operationId":"api.v1.cases.corrections.resolve","summary":"Resolve","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"correctionId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/queues\/approvals":{"get":{"operationId":"api.v1.queues.approvals","summary":"Approvals","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/approvals":{"get":{"operationId":"api.v1.cases.approvals.index","summary":"Index","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/approvals\/{approvalId}\/complete":{"post":{"operationId":"api.v1.cases.approvals.complete","summary":"Complete","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"approvalId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/generated-files\/{fileId}\/download-url":{"get":{"operationId":"api.v1.cases.generated-files.download-url","summary":"Download Url","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/webhooks":{"get":{"operationId":"api.v1.cases.webhooks","summary":"Webhooks","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/webhooks\/{delivery}\/retry":{"post":{"operationId":"api.v1.webhooks.retry","summary":"Retry","parameters":[{"name":"delivery","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/intake\/{intakeId}":{"get":{"operationId":"api.v1.intake.show","summary":"Show","parameters":[{"name":"intakeId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/intake\/{intakeId}\/import":{"post":{"operationId":"api.v1.intake.import","summary":"Import","parameters":[{"name":"intakeId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/intake\/{intakeId}\/handoff":{"post":{"operationId":"api.v1.intake.handoff","summary":"Handoff","parameters":[{"name":"intakeId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/templates":{"get":{"operationId":"api.v1.templates.index","summary":"Index","parameters":[],"responses":{"200":{"description":"JSON response."}}}},"\/templates\/{templateId}":{"get":{"operationId":"api.v1.templates.show","summary":"Show","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms\/{formId}\/ai\/status":{"get":{"operationId":"api.v1.cases.forms.ai.status","summary":"Status","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms\/{formId}\/ai\/suggest":{"post":{"operationId":"api.v1.cases.forms.ai.suggest","summary":"Suggest","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}},"\/cases\/{caseId}\/forms\/{formId}\/ai\/apply":{"post":{"operationId":"api.v1.cases.forms.ai.apply","summary":"Apply","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"JSON response."}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Party":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string","format":"email","nullable":true},"phone":{"type":"string","nullable":true}}},"CaseSummary":{"type":"object","properties":{"id":{"type":"integer"},"reference":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"},"party":{"$ref":"#\/components\/schemas\/Party"},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true}}},"CaseDetail":{"type":"object","properties":{"id":{"type":"integer"},"reference":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"},"party":{"$ref":"#\/components\/schemas\/Party"},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true},"submitted_at":{"type":"string","format":"date-time","nullable":true},"completed_at":{"type":"string","format":"date-time","nullable":true},"forms":{"type":"array","items":{"type":"object"}},"corrections":{"type":"array"},"ekyc":{"type":"object"},"documents":{"type":"array"},"generated_files":{"type":"array"},"recent_activity":{"type":"array"}}},"CaseListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CaseSummary"}},"meta":{"type":"object"}}},"FormsResponse":{"type":"object","properties":{"org":{"type":"object"},"categories":{"type":"array"},"forms":{"type":"array"},"embed":{"type":"object"}}},"CreateCaseRequest":{"type":"object","required":["template_id","party_name"],"properties":{"template_id":{"type":"integer"},"party_name":{"type":"string"},"party_email":{"type":"string","format":"email"},"party_phone":{"type":"string"},"title":{"type":"string"}}},"UpdateCaseRequest":{"type":"object","properties":{"title":{"type":"string"},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"assigned_to_user_id":{"type":"integer","nullable":true}}},"IntakeRequest":{"type":"object","properties":{"file_name":{"type":"string"},"file_base64":{"type":"string"},"channel":{"type":"string"},"template_id":{"type":"integer"},"notes":{"type":"string"}}}}}}