Create a signature request
Issues a signature request to a signatory (by email). The request carries a token the signatory uses to fulfill or deny via the public fulfill/deny endpoints; it expires after `expires_in_days` (default 7, max 365). The actor must be an owner or admin of the event.
/editions/{edition_id}/signature-requestsIssues a signature request to a signatory (by email). The
request carries a token the signatory uses to fulfill or deny
via the public fulfill/deny endpoints; it expires after
expires_in_days (default 7, max 365). The actor must be an
owner or admin of the event.
Authorization
bearerAuth JWT issued by IdentityX, signed with Ed25519
In: header
Path Parameters
Edition ID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for signature request creation. Mirrors models.CreateSignatureRequestRequest.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/editions/497f6eca-6276-4993-bfeb-53cbbbba6f08/signature-requests" \ -H "Content-Type: application/json" \ -d '{ "signatory_name": "Jane Doe", "signatory_title": "Head of Education", "signatory_email": "jane@example.com", "expires_in_days": 14 }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"edition_id": "aeda7fca-56fe-426a-8c37-1876faaaf005",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"signatory_name": "string",
"signatory_title": "string",
"signatory_email": "user@example.com",
"signatory_user_id": "232888e2-acc5-4f86-809b-e06bf28b18e9",
"idempotency_key": "0cd90e5a-2c03-4ab6-81a8-d48818026e58",
"status": "pending",
"status_reason": "string",
"expires_at": "2019-08-24T14:15:22Z",
"signature_id": "ed1e120f-3999-4114-b9d1-d9c58265a493",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 400,
"title": "Validation Failed"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 401,
"title": "Unauthenticated"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 403,
"title": "Insufficient Role"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 404,
"title": "Not Found"
}{
"detail": "string",
"instance": "../dictionary",
"errors": [
{
"field": "string",
"message": "string"
}
],
"type": "http://example.com",
"status": 500,
"title": "Internal Server Error"
}