{"swagger":"2.0","info":{"title":"Taktikal Core API","version":"1.0"},"host":"onboarding.taktikal.is","basePath":"/api","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/signing/activity/total":{"get":{"tags":["signing activity"],"summary":"Gets activity log total to use for paging support","description":"Gets activity log total to use for paging support","operationId":"GetActivityLogTotalactivitytotal_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"StartDate","in":"query","description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","required":true,"x-nullable":false},{"name":"EndDate","in":"query","description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","required":true,"x-nullable":false},{"name":"User","in":"query","description":"The email of the user","type":"string","required":false},{"name":"ProcessKey","in":"query","description":"Use if to be filtered on a single signing process","type":"string","required":false},{"name":"FlowType","in":"query","description":"Can be used to only get activity for a specific flow type.","type":"string","required":false,"enum":["RenderFlow","DropAndSign","FillAndSign","PEP","Compliance","CompanyLookup","Auth","RoaringLookup"]},{"name":"FlowKey","in":"query","description":"If it has a value we only return records that match this flowKey","type":"string","required":false},{"name":"Search","in":"query","description":"If it has a value we will search for processkey or signees: name, email, phone, ssn or the file name","type":"string","required":false},{"name":"StatusFilter","in":"query","description":"A filter only used during search of ActivityLogOwner (default All)","type":"string","required":false,"enum":["All","Completed","InActive","Active"],"x-nullable":false}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ActivityLogTotal"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}":{"post":{"tags":["signing"],"summary":"Authenticate a signee into a signing sequence","description":"Authenticate a signee into a signing sequence","operationId":"RequestToViewSequencesequentialSequenceKey_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","description":"Sequential signing process identifier that has to be provided.","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewSequence"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigning"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/signee":{"post":{"tags":["signing"],"summary":"Add a Signee to an already existing Process","description":"Add a Signee to an already existing Process","operationId":"AddSigneeProcessKeysignee_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/AddSignee"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Signee"}},"401":{"description":"Error codes:\nauthentication.credentials.invalid requires auth and auth header is not basic or bearer\nauthentication.token.invalid requires auth and token is not valid (or not found)","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nerror.signee.wrong.route use sequential route\nerror.signee.process.finished process has already finished. cannot add signees\nerror.signee.add.exists signee already a part of process\nauthentication.token.scope.invalid requires auth but token is not for this process/signee","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nprocess.not_found signingprocess no longer exists. or it requires auth but requested key pair is not correct.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/Auth/Start":{"post":{"tags":["auth"],"summary":"Starts Authentication with a user with his e-id and returns a AuthRequestId that can be used to check if user has finished authenticating","description":"\n            If you are using AuthenticationContextType.Sim then the LoginHint should be an icelandic phone number\n            If you are using AuthenticationContextType.App then the LoginHint should be an SSN\n            and with AuthenticationContextType.App you will also receive a VerificationCode that should be displayed to the user\n            If any failure occurred we will throw an error detailing what happened","operationId":"AuthIntoCreateProcessAuthStart_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/AuthIntoCreateProcess"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StartAuthResponse"}},"403":{"description":"Error codes:\nauthentication.error.audkenni.start error starting auth process with audkenni","schema":{"$ref":"#/definitions/StartAuthResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/Auth/Poll":{"post":{"tags":["auth"],"summary":"Polls the  Authentication with a user with his e-id and returns the Customer\nif authentication has finished that can be used to check if the user\nhas finished authenticating, also returns a signingprocess","description":"AuthRequestId should be the one returned from /Auth/Start\nReturns a PollCustomer object that will\n    * if successful have the customer object filled out according to LookupType\n    * if not, customer object will be null and a StatusMessage detailing why.\n\nThere are three different return types depending on the LookupType\n    1) Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.\n    2) NameAddress: Will return Name, SSN and address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.","operationId":"AuthPollIntoCreateProcessAuthPoll_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/AuthPollIntoCreateProcess"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthPollIntoCreateProcessResult"}},"401":{"description":"Error codes:\nauthentication.error.signee.logon.mismatch\nauthentication.preprocess.netorka.not.exists if preprocess job netorka and no meters are found for ssn","schema":{"$ref":"#/definitions/AuthPollIntoCreateProcessResult"}},"403":{"description":"Error codes:\nauthentication.error.forbidden Some authentication error occured (f.e. timeout)","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"If any of the input is invalid or if a signee ","schema":{"$ref":"#/definitions/ErrorResponse"}},"406":{"description":"If the company is in trial and the trial has expired, returns errorCode 10101","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/auth":{"post":{"tags":["signing"],"summary":"Starts Authentication with a user with his e-id and returns a AuthRequestId that can be used to check if user has finished authenticating","description":"\n            If you are using AuthenticationContextType.Sim then the LoginHint should be an icelandic phone number\n            If you are using AuthenticationContextType.App then the LoginHint should be an SSN\n            and with AuthenticationContextType.App you will also receive a VerificationCode that should be displayed to the user\n            If any failure occured we will throw an error detailing what happened","operationId":"RequestToViewStartProcessKeyauth_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewStart"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StartAuthResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/activity":{"get":{"tags":["signing activity"],"summary":"Gets activity log","description":"Gets activity log","operationId":"GetActivityLogactivity_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"StartDate","in":"query","description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","required":true,"x-nullable":false},{"name":"EndDate","in":"query","description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","required":true,"x-nullable":false},{"name":"Take","in":"query","description":"used to page the result set and only return N many results","type":"integer","format":"int32","required":false},{"name":"Skip","in":"query","description":"used to page the result set and skip the first N results","type":"integer","format":"int32","required":false},{"name":"User","in":"query","description":"The email of the user","type":"string","required":false},{"name":"ProcessKey","in":"query","description":"Use if to be filtered on a single signing process","type":"string","required":false},{"name":"FlowType","in":"query","description":"Can be used to only get activity for a specific flow type.","type":"string","required":false,"enum":["RenderFlow","DropAndSign","FillAndSign","PEP","Compliance","CompanyLookup","Auth","RoaringLookup"]},{"name":"FlowKey","in":"query","description":"If it has a value we only return records that match this flowKey","type":"string","required":false},{"name":"Search","in":"query","description":"If it has a value we will search for processkey or signees: name, email, phone, ssn or the file name","type":"string","required":false},{"name":"StatusFilter","in":"query","description":"A filter only used during search of ActivityLogOwner (default All)","type":"string","required":false,"enum":["All","Completed","InActive","Active"],"x-nullable":false}],"responses":{"200":{"description":"Success","schema":{"title":"List<SigningProcessActivityLogWrapper>","type":"array","items":{"$ref":"#/definitions/SigningProcessActivityLogWrapper"}}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/archive":{"post":{"tags":["document archiving"],"summary":"Archives a signed PDF document by adding a document timestamp (PAdES-B-LTA)","description":"Archives a signed PDF document by adding a document timestamp (PAdES-B-LTA)","operationId":"ArchivingRequestarchive_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/ArchivingRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ArchivingResponse"}},"400":{"description":"if any of the input is invalid","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/ArchivingResponse"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/flow":{"get":{"tags":["flow"],"summary":"Get array of flow details for a company","description":"Get array of flow details for a company","operationId":"MgmtFlowFilterflow_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"title":"List<FlowOverview>","type":"array","items":{"$ref":"#/definitions/FlowOverview"}}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/webhook/":{"post":{"tags":["webhook"],"operationId":"Webhookwebhook_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/Webhook"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Webhook"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/sealing":{"post":{"tags":["document sealing"],"summary":"Takes in a PDF document and seals it","description":"Takes in a PDF document and seals it","operationId":"SealingRequestsealing_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/SealingRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SealingResponse"}},"400":{"description":"if any of the input is invalid ","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/SealingResponse"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/signing":{"post":{"tags":["signing"],"summary":"Creates a new Signing process with a array of signees","description":"Creates a new Signing process with a array of signees","operationId":"CreateSigningProcesssigning_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/CreateSigningProcess"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SigningProcess"}},"400":{"description":"If any of the input is invalid or if a signee ","schema":{"$ref":"#/definitions/ErrorResponse"}},"406":{"description":"If the company is in trial and the trial has expired, returns errorCode 10101","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false,"security":[{"basic":[]}]},"delete":{"tags":["signing"],"summary":"Cancel the Signing process","description":"Cancel the Signing process","operationId":"CancelSigningProcesssigning_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"query","type":"string"},{"name":"User","in":"query","type":"string"}],"responses":{"204":{"description":"No Content"}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/apikeys/validate":{"post":{"tags":["auth"],"summary":"Returns HTTP 200 if the keys are valid","description":"Returns HTTP 200 if the keys are valid","operationId":"ValidateApiKeysapikeysvalidate_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"query","type":"string"},{"name":"WebHookSignatureKey","in":"query","type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/ValidateApiKeys"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/HttpResult"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/flow/{FlowKey}":{"get":{"tags":["flow"],"summary":"Get a flow details by a flow key","description":"Get a flow details by a flow key","operationId":"MgmtGetFlowflowFlowKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The key for a specific flow","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Flow"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/smartflows/{FlowKey}":{"get":{"tags":["flow"],"operationId":"GetSmartFlowVersionssmartflowsFlowKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"title":"List<SmartFlowSchemaVersion>","type":"array","items":{"$ref":"#/definitions/SmartFlowSchemaVersion"}}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/webhook/{Id}":{"put":{"tags":["webhook"],"operationId":"WebhookwebhookId_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Id","in":"path","description":"The id of a webhook required for update (PUT)","type":"integer","format":"int32","required":true,"x-nullable":false},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Webhook"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Webhook"}}},"deprecated":false,"security":[{"basic":[]}]},"delete":{"tags":["webhook"],"summary":"Delete a webhook","description":"Delete a webhook","operationId":"DeleteWebhookwebhookId_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Id","in":"path","description":"The id of a webhook","type":"integer","format":"int32","required":true,"x-nullable":false}],"responses":{"204":{"description":"No Content"}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/sealing/xml":{"post":{"tags":["document sealing"],"summary":"Takes in a XML document and seals it","description":"Takes in a XML document and seals it","operationId":"SealingXmlRequestsealingxml_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/SealingXmlRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Object"}},"400":{"description":"if any of the input is invalid ","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/signing/sequential":{"post":{"tags":["signing"],"summary":"Creates a new Sequential Signing process (Bulk) with a array of Signing Processes.\n                    Each Signing process has an array of signees.\n                    Example: A company wants document A and B signed. Signee X should sign document A and B, Signee Y should sign document A and Signee Z should sign Document B.\n                    Then A new CreateSequentialSigning with array of two CreateSigningProcess object. Signees X and Y are added as signees for CreateSigningProcess for Document A\n                    and signees X and Z are added as signees for Document B","description":"Creates a new Sequential Signing process (Bulk) with a array of Signing Processes.\n                    Each Signing process has an array of signees.\n                    Example: A company wants document A and B signed. Signee X should sign document A and B, Signee Y should sign document A and Signee Z should sign Document B.\n                    Then A new CreateSequentialSigning with array of two CreateSigningProcess object. Signees X and Y are added as signees for CreateSigningProcess for Document A\n                    and signees X and Z are added as signees for Document B","operationId":"CreateSequentialSigningsigningsequential_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/CreateSequentialSigning"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigning"}}},"deprecated":false,"security":[{"basic":[]}]},"delete":{"tags":["signing"],"summary":"Cancel the sequential signing process","description":"Cancel the sequential signing process","operationId":"CancelSequenceSigningsigningsequential_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"query","description":"Sequential signing process identifier that has to be provided.","type":"string","required":true},{"name":"User","in":"query","description":"Only the person who started the signing process can cancel it.","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigning"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/signing/example":{"get":{"tags":["signing"],"summary":"Generates an example json of data to create a signing process","description":"Generates an example json of data to create a signing process","operationId":"GetSigningProcessExamplesigningexample_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CreateSigningProcessExample"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/Auth":{"post":{"tags":["auth"],"summary":"Authenticates a user with e-id and returns personal info","description":"Returns a 'Customer' object but with different amount of information filled out depending on the 'LookupType'.\n\nThere are three different return types depending on the LookupType\n    1) Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.\n    2) NameAddress: Will return Name, SSN and address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.\n    3) NameAddressFamily: Returns Name, SSN, Address data, gender code, and family information.","operationId":"Auth_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/Auth"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Customer"}},"404":{"description":"Error codes:\nflow.not_found","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nauthentication.error.forbidden is not authenticated, (could have canceled etc, see error description for further info)","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/Auth/Start":{"post":{"tags":["auth"],"summary":"Starts Authentication with a user with his e-id and returns a AuthRequestId that can be used to check if user has finished authenticating","description":"\n            If you are using AuthenticationContextType.Sim then the LoginHint should be an icelandic phone number\n            If you are using AuthenticationContextType.App then the LoginHint should be an SSN\n            and with AuthenticationContextType.App you will also receive a VerificationCode that should be displayed to the user\n            If any failure occured we will throw an error detailing what happened","operationId":"AuthStartStart_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/AuthStart"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StartAuthResponse"}},"403":{"description":"Error codes:\nauthentication.error.audkenni.start error starting auth process with audkenni","schema":{"$ref":"#/definitions/StartAuthResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/Auth/Poll":{"post":{"tags":["auth"],"summary":"Polls the  Authentication with a user with his e-id and returns the Customer if authentication has finished that can be used to check if the user has finished authenticating","description":"\n            AuthRequestId should be the one returned from /Auth/Start\n            Returns a PollCustomer object that will\n                * if successful have the customer object filled out according to LookupType\n                * if not, customer object will be null and a StatusMessage detailing why.\n\n            There are three different return types depending on the LookupType\n                1) Name: Will only return the SSN and Name of the authenticated person. This has no additional lookup cost.\n                2) NameAddress: Will return Name, SSN and address information. This has an additional lookup cost. This is the default value if no value is given for LookupType.","operationId":"AuthPollPoll_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/AuthPoll"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/PollCustomer"}},"401":{"description":"Error codes:\nauthentication.error.signee.logon.mismatch\nauthentication.preprocess.netorka.not.exists if preprocess job netorka and no meters are found for ssn","schema":{"$ref":"#/definitions/PollCustomer"}},"403":{"description":"Error codes:\nauthentication.error.forbidden Some authentication error occured (f.e. timeout)","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/compliances/individuals/status":{"get":{"tags":["compliance"],"summary":"Gets status of an individual","description":"Gets status of an individual","operationId":"IndividualComplianceStatusRequestcompliancesindividualsstatus_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Ssn","in":"query","type":"string"},{"name":"Email","in":"query","type":"string"},{"name":"Phone","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/IndividualComplianceStatus"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/compliances/businesses/status":{"get":{"tags":["compliance"],"summary":"Gets status of a business","description":"Gets status of a business","operationId":"BusinessComplianceStatusRequestcompliancesbusinessesstatus_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Ssn","in":"query","type":"string"},{"name":"Name","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BusinessComplianceStatus"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/flow/css/{FlowKey}.css":{"get":{"tags":["flow"],"summary":"Get the css content for a flow","description":"Get the css content for a flow","operationId":"MgmtFlowCssContentflowcssFlowKey.css_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The key for a specific flow","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FlowCustomCss"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/smartflows/{FlowKey}/{Version}":{"get":{"tags":["flow"],"operationId":"GetSmartFlowSchemasmartflowsFlowKeyVersion_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","type":"string","required":true},{"name":"Version","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SmartFlowSchema"}}},"deprecated":false},"put":{"tags":["flow"],"summary":"Update or insert a new smartflow schema (Upsert)","description":"Update or insert a new smartflow schema (Upsert)","operationId":"SaveSmartflowSchemasmartflowsFlowKeyVersion_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","type":"string","required":true},{"name":"Version","in":"path","type":"string","required":true},{"name":"Schema","in":"query","type":"string"},{"name":"CreatedAt","in":"query","type":"string","format":"date-time"},{"name":"UpdatedAt","in":"query","type":"string","format":"date-time"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/SaveSmartflowSchema"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SmartFlowSchema"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/webhook/flowKey/{FlowKey}":{"get":{"tags":["webhook"],"summary":"Get a webhook for a flow","description":"Get a webhook for a flow","operationId":"GetWebhookswebhookflowKeyFlowKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The flowKey to get all webhooks for","type":"string","required":true},{"name":"Type","in":"query","description":"Can be empty to get all webhooks","type":"string","required":false,"enum":["NotSet","SignedDocument","AllSigned","Auth","Signup","Canceled","Expired","Reminder","CompanyTermination","EmailVerification","Completed","Created","GroupSigned"]}],"responses":{"200":{"description":"Success","schema":{"title":"List<Webhook>","type":"array","items":{"$ref":"#/definitions/Webhook"}}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/status/processkey/{ProcessKey}/signeekey/{SigneeKey}/token/{Token}/":{"get":{"tags":["signing"],"summary":"Checks the status of the document and returns it if it's signed","description":"You most likely will not need using this endpoint. It's used by the frontend but can be used if your have your own UI.","operationId":"SignDocumentStatusRequeststatusprocesskeyProcessKeysigneekeySigneeKeytokenToken_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Token","in":"path","type":"string","required":true},{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SignDocumentStatusResponse"}},"404":{"description":"Error codes:\nprocess.not_found signingprocess no longer exists. or it requires auth but requested key pair is not correct.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/auth":{"post":{"tags":["signing"],"summary":"Starts Authentication with a user with his e-id and returns a AuthRequestId that can be used to check if user has finished authenticating","description":"\n            If you are using AuthenticationContextType.Sim then the LoginHint should be an icelandic phone number\n            If you are using AuthenticationContextType.App then the LoginHint should be an SSN\n            and with AuthenticationContextType.App you will also receive a VerificationCode that should be displayed to the user\n            If any failure occured we will throw an error detailing what happened","operationId":"RequestToViewSequenceStartsequentialSequenceKeyauth_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewSequenceStart"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StartAuthResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/signee":{"post":{"tags":["signing"],"summary":"Add a Sequential Signee to an already existing Sequence","description":"Add a Sequential Signee to an already existing Sequence","operationId":"AddSequentialSigneesequentialSequenceKeysignee_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/AddSequentialSignee"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigningSignee"}},"403":{"description":"Error codes:\nerror.signee.wrong.route use sequential route\nerror.signee.process.finished process has already finished. cannot add signees\nerror.signee.add.exists signee already a part of process","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nsequence.canceled\nsequence.not_found","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/signee/{SigneeKey}":{"get":{"tags":["signing"],"summary":"Get's the signing process by signeeKey","description":"Get's the signing process by signeeKey","operationId":"GetSigningProcessBySigneeProcessKeysigneeSigneeKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"UserAgent","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SigningProcess"}},"401":{"description":"Default if no auth header for a RequiresAuth process\nError codes:\nauthentication.credentials.invalid requires auth and auth header is not basic or bearer\nauthentication.token.invalid requires auth and token is not valid (or not found)","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nauthentication.token.scope.invalid requires auth but token is not for this process/signee","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nerror.signee.not_found\nprocess.not_found signingprocess no longer exists. or it requires auth but requested key pair is not correct.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"put":{"tags":["signing"],"summary":"Update a Signee","description":"Update a Signee","operationId":"UpdateSigneeProcessKeysigneeSigneeKey_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/UpdateSignee"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Signee"}}},"deprecated":false},"delete":{"tags":["signing"],"summary":"Remove a Signee","description":"Remove a Signee","operationId":"RemoveSigneeProcessKeysigneeSigneeKey_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"ProcessKey","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Signee"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/auth/poll":{"post":{"tags":["signing"],"summary":"Polls the  Authentication with a user with his e-id and returns the Customer if authentication has finished that can be used to check if the user has finished authenticating","description":"\n            AuthRequestId should be the one returned from /signing/{ProcessKey}/auth\n            ","operationId":"RequestToViewPollProcessKeyauthpoll_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewPoll"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RequestToViewPollResult"}},"401":{"description":"Error codes:\nauthentication.error.signee.logon.mismatch","schema":{"$ref":"#/definitions/RequestToViewPollResult"}},"403":{"description":"Error codes:\nauthentication.error.forbidden Some authentication error occured (f.e. timeout)","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/flow/css/{FlowKey}.css":{"get":{"tags":["flow"],"summary":"Get Flow custom css content","description":"Get Flow custom css content","operationId":"FlowCssContentcssFlowKey.css_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The key for a specific flow","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FlowCustomCss"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/flow/{FlowKey}":{"get":{"tags":["flow"],"summary":"Get array of flow details by key","description":"Get array of flow details by key","operationId":"FlowFilterFlowKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The key for a specific flow","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"title":"List<FlowOverview>","type":"array","items":{"$ref":"#/definitions/FlowOverview"}}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/flow/company/":{"get":{"tags":["flow"],"summary":"Get the an array of flow overview details","description":"Get the an array of flow overview details","operationId":"FlowCompanyFiltercompany_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"title":"List<FlowOverview>","type":"array","items":{"$ref":"#/definitions/FlowOverview"}}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/flow/{FlowKey}/registered/deliveries":{"get":{"tags":["flow"],"summary":"Gets all registered delivery methods for this flowKey, email, and webhooks.\n        Will return the types of delivers registered, not the actual content","description":"Gets all registered delivery methods for this flowKey, email, and webhooks.\n        Will return the types of delivers registered, not the actual content","operationId":"GetFlowDeliveriesFlowKeyregistereddeliveries_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"FlowKey","in":"path","description":"The key for a specific flow","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FlowDeliveries"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/pdf/CheckDocumentSigners/":{"post":{"tags":["pdf"],"summary":"Checks if a document can be signed and if it can it returns a list of signatures already in the document, if any.\nIf the PDF is encrypted it returns an error.\nIf the PDF is corrupted it returns an error","description":"Checks if a document can be signed and if it can it returns a list of signatures already in the document, if any.\nIf the PDF is encrypted it returns an error.\nIf the PDF is corrupted it returns an error","operationId":"CheckDocumentSigningRequestCheckDocumentSigners_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"body","in":"body","schema":{"$ref":"#/definitions/CheckDocumentSigningRequest"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CheckDocumentSigningResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/pdf/{ProcessKey}/{SigneeKey}.pdf":{"get":{"tags":["pdf"],"summary":"This endpoint allows you to retrieve PDF documents from a signing process. If the document has been signed, it will return the PDF with the signatures included. This endpoint serves as an alternative to webhooks for retrieving completed signed documents.\n","description":"This endpoint allows you to retrieve PDF documents from a signing process. If the document has been signed, it will return the PDF with the signatures included. This endpoint serves as an alternative to webhooks for retrieving completed signed documents.\n","operationId":"GetPdfForSigningProcessPreviewProcessKeySigneeKey.pdf_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","description":"The signing process key provided when create a signing process","type":"string","required":true},{"name":"SigneeKey","in":"path","description":"The signee key representing a signer of the document ","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/GetPdfForPreviewResponse"}}},"deprecated":false},"head":{"tags":["pdf"],"summary":"This endpoint allows you to retrieve PDF documents from a signing process. If the document has been signed, it will return the PDF with the signatures included. This endpoint serves as an alternative to webhooks for retrieving completed signed documents.\n","description":"This endpoint allows you to retrieve PDF documents from a signing process. If the document has been signed, it will return the PDF with the signatures included. This endpoint serves as an alternative to webhooks for retrieving completed signed documents.\n","operationId":"GetPdfForSigningProcessPreviewProcessKeySigneeKey.pdf","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","description":"The signing process key provided when create a signing process","type":"string","required":true},{"name":"SigneeKey","in":"path","description":"The signee key representing a signer of the document ","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/GetPdfForSigningProcessPreview"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/GetPdfForPreviewResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/auth/poll":{"post":{"tags":["signing"],"summary":"Polls the Authentication with a user with his e-id and returns the Customer if authentication has finished that can be used to check if the user has finished authenticating","description":"\n            AuthRequestId should be the one returned from /signing/sequential/{SequenceKey}/auth\n            ","operationId":"RequestToViewSequencePollsequentialSequenceKeyauthpoll_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewSequencePoll"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RequestToViewSequencePollResult"}},"401":{"description":"Error codes:\nsequence.signee.not_found\nauthentication.error.signee.logon.mismatch","schema":{"$ref":"#/definitions/RequestToViewSequencePollResult"}},"404":{"description":"Error codes:\nsequence.canceled\nsequence.not_found","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nauthentication.error.forbidden Some authentication error occured (f.e. timeout)","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/signee/{SequentialSigneeKey}":{"get":{"tags":["signing"],"operationId":"GetSequentialSigningsequentialSequenceKeysigneeSequentialSigneeKey_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"SequentialSigneeKey","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigning"}}},"deprecated":false},"put":{"tags":["signing"],"summary":"Update a SequentialSignee","description":"Update a SequentialSignee","operationId":"UpdateSequentialSigneesequentialSequenceKeysigneeSequentialSigneeKey_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequentialSigneeKey","in":"path","type":"string","required":true},{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/UpdateSequentialSignee"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigningSignee"}}},"deprecated":false},"delete":{"tags":["signing"],"summary":"Remove a SequentialSignee","description":"Remove a SequentialSignee","operationId":"RemoveSequentialSigneesequentialSequenceKeysigneeSequentialSigneeKey_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequentialSigneeKey","in":"path","type":"string","required":true},{"name":"SequenceKey","in":"path","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigningSignee"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/signee/{SigneeKey}/attachment":{"post":{"tags":["signing process attachment"],"summary":"Adds a new attachment to the signingProcess. Reads the attachment from the form-data","description":"Adds a new attachment to the signingProcess. Reads the attachment from the form-data","operationId":"CreateAttachmentReferenceProcessKeysigneeSigneeKeyattachment_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","description":"The signing process key","type":"string","required":true},{"name":"SigneeKey","in":"path","description":"The person who is signing key","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/CreateAttachmentReference"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AttachmentReference"}},"400":{"description":"No files in request | More than one File in request. Please only send one file at a time","schema":{"$ref":"#/definitions/AttachmentReference"}},"406":{"description":"Can't add an attachment to a none active signingProcess","schema":{"$ref":"#/definitions/AttachmentReference"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sign/{ProcessKey}/signee/{SigneeKey}":{"post":{"tags":["signing"],"summary":"Starts the signin process for a given SigneeKey","description":"Starts the signin process for a given SigneeKey","operationId":"RequestToSignsignProcessKeysigneeSigneeKey_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","description":"The signing process key","type":"string","required":true},{"name":"SigneeKey","in":"path","description":"The person who is signing key","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToSign"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SignDocumentResponse"}},"401":{"description":"Default if no auth header for a RequiresAuth process\nError codes:\nauthentication.credentials.invalid requires auth and auth header is not basic or bearer\nauthentication.token.invalid requires auth and token is not valid (or not found)","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\n2001 Process is currently locked by another signee (otp signing)\n2002 Process is currently locked by another signee\nauthentication.token.scope.invalid requires auth but token is not for this process/signee\nsigning.forbidden.canceled Process has been canceled\nsigning.forbidden.expired Process has expired\nsigning.forbidden.signee.signed signee already signed\nsigning.forbidden.verification.missing verification is missing (if applicable)","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nprocess.not_found Process no longer exists. or it requires auth but requested key pair is not correct.\nerror.signee.not_found Signee key is not a part of process\nflow.not_found Flow cannot be found\nprocess.file.not_found PDf file cannot be found","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/signee/{SigneeKey}/passcode":{"post":{"tags":["signing"],"summary":"Authenticate a signee into a signing process","description":"Will return a base64Encoded AccessToken in the header x-access-token.\nThat is needed to access the signingProcess and the document","operationId":"RequestToViewPasscodeProcessProcessKeysigneeSigneeKeypasscode_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewPasscodeProcess"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SigningProcess"}},"403":{"description":"Error codes:\nprocess.passcode.not_valid","schema":{"$ref":"#/definitions/SigningProcess"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/signee/{SigneeKey}/meta":{"put":{"tags":["signing"],"summary":"Updates the signingProcess meta object. Will merge with the current value","description":"Updates the signingProcess meta object. Will merge with the current value","operationId":"UpdateSigningProcessMetaProcessKeysigneeSigneeKeymeta_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/UpdateSigningProcessMeta"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SigningProcess"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/signee/{SequentialSigneeKey}/Token":{"post":{"tags":["signing"],"summary":"Creates an Access Token that is valid for this signingProcess","description":"Creates an Access Token that is valid for this signingProcess","operationId":"CreateSequenceAccessTokensequentialSequenceKeysigneeSequentialSigneeKeyToken_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"SequentialSigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/CreateSequenceAccessToken"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TaktikalAccessToken"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/{ProcessKey}/attachment/{Id}/fileName/{FileName}":{"get":{"tags":["signing process attachment"],"summary":"Gets an attachment with a given Id for a given signingProcess","description":"Gets an attachment with a given Id for a given signingProcess","operationId":"GetAttachmentProcessKeyattachmentIdfileNameFileName_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Id","in":"path","description":"The id of the reference ","type":"string","required":true},{"name":"ProcessKey","in":"path","description":"The signing process key","type":"string","required":true},{"name":"FileName","in":"path","description":"The filename including the type","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"delete":{"tags":["signing process attachment"],"summary":"Deletes an attachment for a signingProcess","description":"Deletes an attachment for a signingProcess","operationId":"DeleteAttachmentReferenceProcessKeyattachmentIdfileNameFileName_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Id","in":"path","description":"The id of the reference to be deleted","type":"string","required":true},{"name":"ProcessKey","in":"path","description":"The signing process key","type":"string","required":true},{"name":"FileName","in":"path","description":"The filename including the type","type":"string","required":true}],"responses":{"204":{"description":"No Content"}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequential/{SequenceKey}/signee/{SequentialSigneeKey}/passcode":{"post":{"tags":["signing"],"summary":"Authenticate a signee into a signing sequence","description":"Authenticate a signee into a signing sequence","operationId":"RequestToViewPasscodeSequencesequentialSequenceKeysigneeSequentialSigneeKeypasscode_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","description":"Sequential signing process identifier that has to be provided.","type":"string","required":true},{"name":"SequentialSigneeKey","in":"path","description":"Sequential signing signee key identifier that has to be provided.","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToViewPasscodeSequence"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SequentialSigning"}},"403":{"description":"Error codes:\nprocess.passcode.not_valid","schema":{"$ref":"#/definitions/SequentialSigning"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/process/{ProcessKey}/signee/{SigneeKey}/remind":{"delete":{"tags":["signing"],"summary":"Cancels all signing reminders for a signee","description":"Cancels all signing reminders for a signee","operationId":"DeleteSigningReminderprocessProcessKeysigneeSigneeKeyremind_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","description":"","type":"string","required":true},{"name":"SigneeKey","in":"path","description":"","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sequence/{SequenceKey}/signee/{SequenceSigneeKey}/remind":{"delete":{"tags":["signing"],"summary":"Cancels all signing reminders for a signee","description":"Cancels all signing reminders for a signee","operationId":"DeleteSigningRemindersequenceSequenceKeysigneeSequenceSigneeKeyremind_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","description":"","type":"string","required":true},{"name":"SequenceSigneeKey","in":"path","description":"","type":"string","required":true}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/signing/{ProcessKey}/signee/{SigneeKey}/remind":{"post":{"tags":["signing"],"summary":"Sends a reminder to the signee telling him he needs to sign.\nIf this process is part of a sequence a reminder for the sequence is sent instead.","description":"Sends a reminder to the signee telling him he needs to sign.\nIf this process is part of a sequence a reminder for the sequence is sent instead.","operationId":"SendSigningRemindersigningProcessKeysigneeSigneeKeyremind_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"User","in":"query","type":"string"},{"name":"CommunicationDeliveryType","in":"query","type":"string","enum":["None","Sms","Email"],"x-nullable":false},{"name":"IncludeUnsubscribe","in":"query","type":"boolean","x-nullable":false},{"name":"body","in":"body","schema":{"$ref":"#/definitions/SendSigningReminder"}}],"responses":{"200":{"description":"Success","schema":{"title":"String","type":"string"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/management/signing/{ProcessKey}/signee/{SigneeKey}/token":{"post":{"tags":["signing"],"summary":"Creates an Access Token that is valid for this signingProcess","description":"Creates an Access Token that is valid for this signingProcess","operationId":"CreateSigningProcessTokensigningProcessKeysigneeSigneeKeytoken_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"ProcessKey","in":"path","type":"string","required":true},{"name":"SigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/CreateSigningProcessToken"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sign/simple/sequence/{SequenceKey}/signee/{SequentialSigneeKey}":{"post":{"tags":["signing"],"summary":"Bulk sign all documents that this signee has in this sequence","description":"Bulk sign all documents that this signee has in this sequence","operationId":"RequestToBulkSignsignsimplesequenceSequenceKeysigneeSequentialSigneeKey_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"SequentialSigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToBulkSign"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BulkSignDocumentResponse"}},"400":{"description":"Error codes:\nsigning.wrong.signature_type If signature type is qualifed or ClickToSign (Different endpoint for clicktosign)","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nsigning.forbidden.canceled Process has been canceled","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nsequence.canceled Sequnece’s been canceled\nsequence.not_found\nsequence.signee.not_found\nprocess.not_found signingprocess no longer exists. or it requires auth but requested key pair is not correct.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/signing/sign/click/sequence/{SequenceKey}/signee/{SequentialSigneeKey}":{"post":{"tags":["signing"],"summary":"Bulk sign all documents that this signee has in this sequence","description":"Bulk sign all documents that this signee has in this sequence","operationId":"RequestToBulkSignsignclicksequenceSequenceKeysigneeSequentialSigneeKey_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"SequenceKey","in":"path","type":"string","required":true},{"name":"SequentialSigneeKey","in":"path","type":"string","required":true},{"name":"body","in":"body","schema":{"$ref":"#/definitions/RequestToBulkSign"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BulkSignDocumentResponse"}},"400":{"description":"Error codes:\nsigning.wrong.signature_type If signature type is qualifed or ClickToSign (Different endpoint for clicktosign)","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Error codes:\nsigning.forbidden.canceled Process has been canceled","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Error codes:\nsequence.canceled Sequnece’s been canceled\nsequence.not_found\nsequence.signee.not_found\nprocess.not_found signingprocess no longer exists. or it requires auth but requested key pair is not correct.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/statistics/distanceandtime":{"get":{"tags":["statistics"],"summary":"Get the distance and time if the signee would have driven to the closest company address. Aggregated for all companies.","description":"Get the distance and time if the signee would have driven to the closest company address. Aggregated for all companies.","operationId":"GlobalStatsDistanceAndTimeFilterdistanceandtime_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"StartDate","in":"query","description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","required":true},{"name":"EndDate","in":"query","description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","required":true},{"name":"MinDistance","in":"query","description":"The minimum distance traveled in meters","type":"integer","format":"int32","required":false},{"name":"MaxDistance","in":"query","description":"The maximum distance traveled in meters","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StatsDistanceAndTimeResult"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/statistics/company/distanceandtime":{"get":{"tags":["statistics"],"summary":"Get the distance and time if the signee would have driven to the closest company address. For a single company.","description":"Get the distance and time if the signee would have driven to the closest company address. For a single company.","operationId":"CompanyStatsDistanceAndTimeFiltercompanydistanceandtime_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"PublicCompanyKey","in":"query","description":"The public company key that is provided in app.taktikal","type":"string","required":true},{"name":"StartDate","in":"query","description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","required":true},{"name":"EndDate","in":"query","description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","required":true},{"name":"MinDistance","in":"query","description":"The minimum distance traveled in meters","type":"integer","format":"int32","required":false},{"name":"MaxDistance","in":"query","description":"The maximum distance traveled in meters","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/StatsDistanceAndTimeResult"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/watchlist/person/":{"post":{"tags":["watchlist"],"summary":"PEP and Sanction lookup for a person","description":"PEP and Sanction lookup for a person","operationId":"WatchListRequestPublicperson_Post","consumes":["application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"CountryCode","in":"formData","description":"Country code. example : US, SE etc","type":"string","required":false},{"name":"FirstName","in":"formData","description":"First Name - this field is mandatory (unless you are entering an OriginalName)","type":"string","required":false},{"name":"MiddleName","in":"formData","description":"Middle name. Not available in all WatchListServices","type":"string","required":false},{"name":"LastName","in":"formData","description":"Last Name - this field is mandatory (unless you are entering an OriginalName)","type":"string","required":false},{"name":"OriginalName","in":"formData","description":"This parameter has multiple uses and supports either the individual's full name in original script text (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name if you are unable to separate based on first, middle and last Name. This field is mandatory, unless you are entering a first and last Name.","type":"string","required":false},{"name":"DateOfBirth","in":"formData","description":"Date of birth (YYYY-MM-DD)","type":"string","required":false},{"name":"Gender","in":"formData","description":"Gender. Can be “Male” or “Female”. ","type":"string","required":false},{"name":"MatchRate","in":"formData","description":"A percentage from 1-99, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 99% being very close. Only applicable if matchType is Close","type":"integer","format":"int32","required":false,"x-nullable":false},{"name":"MatchType","in":"formData","description":"Used to determine how closely a watchlist entity must match a member before being considered a match. The options are Exact, ExactMidName or Close. Default is Exact.","type":"string","required":false},{"name":"FlowKey","in":"formData","description":"The Flow key connected to the query","type":"string","required":false},{"name":"body","in":"body","schema":{"$ref":"#/definitions/WatchListRequestPublic"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/WatchListResponse"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/watchlist/company/":{"post":{"tags":["watchlist"],"summary":"PEP and Sanction lookup for a company","description":"PEP and Sanction lookup for a company","operationId":"WatchListCompanyRequestPubliccompany_Post","consumes":["application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"Metadata","in":"formData","schema":{"$ref":"#/definitions/MetadataPepCompany"},"description":"Search criteria","required":false},{"name":"FlowKey","in":"formData","description":"The Flow key connected to the query","type":"string","required":false},{"name":"body","in":"body","schema":{"$ref":"#/definitions/WatchListCompanyRequestPublic"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/WatchListResponse"}}},"deprecated":false,"security":[{"basic":[]}]},"parameters":[{"$ref":"#/parameters/Accept"}]},"/ss-auth":{"get":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticate_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"query","type":"string"},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"put":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticate_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"query","type":"string"},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Authenticate"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"post":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticate_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"query","type":"string"},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Authenticate"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"delete":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticate_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"query","type":"string"},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]},"/ss-auth/{provider}":{"get":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticateprovider_Get","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"path","type":"string","required":true},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"put":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticateprovider_Create","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"path","type":"string","required":true},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Authenticate"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"post":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticateprovider_Post","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"path","type":"string","required":true},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"},{"name":"body","in":"body","schema":{"$ref":"#/definitions/Authenticate"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"delete":{"tags":["auth"],"summary":"Sign In","description":"Sign In","operationId":"Authenticateprovider_Delete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"provider","in":"path","type":"string","required":true},{"name":"UserName","in":"query","type":"string"},{"name":"Password","in":"query","type":"string"},{"name":"RememberMe","in":"query","type":"boolean"},{"name":"AccessToken","in":"query","type":"string"},{"name":"AccessTokenSecret","in":"query","type":"string"},{"name":"ReturnUrl","in":"query","type":"string"},{"name":"ErrorView","in":"query","type":"string"},{"name":"Meta","in":"query","type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AuthenticateResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]}},"definitions":{"Object":{"properties":{},"description":"Object","type":"object"},"GetActivityLogTotal":{"title":"GetActivityLogTotal","required":["startDate","endDate"],"properties":{"startDate":{"description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","x-nullable":false},"endDate":{"description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","x-nullable":false},"user":{"description":"The email of the user","type":"string"},"processKey":{"description":"Use if to be filtered on a single signing process","type":"string"},"flowType":{"description":"Can be used to only get activity for a specific flow type.","type":"string","enum":["RenderFlow","DropAndSign","FillAndSign","PEP","Compliance","CompanyLookup","Auth","RoaringLookup"]},"flowKey":{"description":"If it has a value we only return records that match this flowKey","type":"string"},"search":{"description":"If it has a value we will search for processkey or signees: name, email, phone, ssn or the file name","type":"string"},"statusFilter":{"description":"A filter only used during search of ActivityLogOwner (default All)","type":"string"}},"description":"GetActivityLogTotal","type":"object"},"RequestToViewSequence":{"title":"RequestToViewSequence","required":["sequenceKey","phoneNumber"],"properties":{"sequenceKey":{"description":"Sequential signing process identifier that has to be provided.","type":"string"},"phoneNumber":{"description":"Sequential signee phone number","type":"string"}},"description":"RequestToViewSequence","type":"object"},"AddSignee":{"title":"AddSignee","required":["processKey"],"properties":{"processKey":{"type":"string"},"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"reason":{"type":"string"},"hidePersonalCode":{"type":"boolean","x-nullable":false},"communicationDeliveryType":{"type":"string"},"customSmsText":{"type":"string"},"signatureType":{"type":"string"},"language":{"type":"string"},"addedBy":{"type":"string"},"passcode":{"type":"string"},"groupOrder":{"type":"integer","format":"int32"}},"description":"AddSignee","type":"object"},"AuthIntoCreateProcess":{"title":"AuthIntoCreateProcess","required":["email","flowKey","authenticationContextType"],"properties":{"email":{"description":"The e-mail address of the user that send the request. this is required.","type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"flowKey":{"type":"string"},"authenticationContextType":{"type":"string","enum":["Sim","App"]},"includeVerificationCode":{"type":"boolean","x-nullable":false},"meta":{"$ref":"#/definitions/JsonAwareStringDictionary"}},"description":"AuthIntoCreateProcess","type":"object"},"JsonAwareStringDictionary":{"title":"JsonAwareStringDictionary","properties":{"comparer":{"$ref":"#/definitions/IEqualityComparer_String_"},"count":{"type":"integer","format":"int32","x-nullable":false},"keys":{"$ref":"#/definitions/KeyCollection_String_String_"},"values":{"$ref":"#/definitions/ValueCollection_String_String_"},"item":{"type":"string"}},"description":"JsonAwareStringDictionary","type":"object"},"IEqualityComparer_String_":{"title":"IEqualityComparer`1","properties":{},"description":"IEqualityComparer<String>","type":"object"},"KeyCollection_String_String_":{"title":"KeyCollection","properties":{},"description":"KeyCollection<String,String>","type":"object"},"ValueCollection_String_String_":{"title":"ValueCollection","properties":{},"description":"ValueCollection<String,String>","type":"object"},"AuthPollIntoCreateProcess":{"title":"AuthPollIntoCreateProcess","required":["authRequestId","flowKey","lookupType"],"properties":{"authRequestId":{"type":"string"},"flowKey":{"type":"string"},"lookupType":{"type":"string","enum":["NameAddress","Name","NameAddressFamily"]}},"description":"AuthPollIntoCreateProcess","type":"object"},"RequestToViewStart":{"title":"RequestToViewStart","required":["processKey","authenticationContextType"],"properties":{"processKey":{"type":"string"},"loginHint":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"authenticationContextType":{"type":"string","enum":["Sim","App"]},"includeVerificationCode":{"type":"boolean","x-nullable":false}},"description":"RequestToViewStart","type":"object"},"GetActivityLog":{"title":"GetActivityLog","required":["startDate","endDate"],"properties":{"startDate":{"description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time","x-nullable":false},"endDate":{"description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time","x-nullable":false},"take":{"description":"used to page the result set and only return N many results","type":"integer","format":"int32"},"skip":{"description":"used to page the result set and skip the first N results","type":"integer","format":"int32"},"user":{"description":"The email of the user","type":"string"},"processKey":{"description":"Use if to be filtered on a single signing process","type":"string"},"flowType":{"description":"Can be used to only get activity for a specific flow type.","type":"string","enum":["RenderFlow","DropAndSign","FillAndSign","PEP","Compliance","CompanyLookup","Auth","RoaringLookup"]},"flowKey":{"description":"If it has a value we only return records that match this flowKey","type":"string"},"search":{"description":"If it has a value we will search for processkey or signees: name, email, phone, ssn or the file name","type":"string"},"statusFilter":{"description":"A filter only used during search of ActivityLogOwner (default All)","type":"string"}},"description":"GetActivityLog","type":"object"},"ArchivingRequest":{"title":"ArchivingRequest","required":["pdfDocument","fileName"],"properties":{"pdfDocument":{"description":"Base64String of the signed PDF document to archive","type":"string"},"fileName":{"description":"Filename including extension","type":"string"}},"description":"ArchivingRequest","type":"object"},"MgmtFlowFilter":{"title":"MgmtFlowFilter","properties":{},"description":"MgmtFlowFilter","type":"object"},"Webhook":{"title":"Webhook","required":["flowKey","url"],"properties":{"id":{"description":"The id of a webhook required for update (PUT)","type":"integer","format":"int32","x-nullable":false},"flowKey":{"description":"Each webhook is registered on a flow. There can be many webhooks per flow.","type":"string"},"url":{"$ref":"#/definitions/Uri","description":"A publicly acceptable URL that can receive the event"},"sampleData":{"$ref":"#/definitions/WebhookEventPayload"},"type":{"type":"string","enum":["NotSet","SignedDocument","AllSigned","Auth","Signup","Canceled","Expired","Reminder","CompanyTermination","EmailVerification","Completed","Created","GroupSigned"]}},"description":"Webhook","type":"object"},"Uri":{"title":"Uri","properties":{},"description":"Uri","type":"object"},"WebhookEventPayload":{"title":"WebhookEventPayload","properties":{"id":{"type":"string"},"eventData":{"$ref":"#/definitions/SignedDocumentEventData"},"eventSignature":{"$ref":"#/definitions/EventSignature"}},"description":"WebhookEventPayload","type":"object"},"SignedDocumentEventData":{"title":"SignedDocumentEventData","properties":{"processKey":{"type":"string"},"signees":{"type":"array","items":{"$ref":"#/definitions/Signee"}},"flowKey":{"type":"string"},"flowName":{"type":"string"},"signedDocument":{"type":"string"},"signedDocumentDownloadUrl":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/SigningAttachment"}},"attachmentReferences":{"type":"array","items":{"$ref":"#/definitions/AttachmentReference"}},"eventType":{"type":"string"},"meta":{"$ref":"#/definitions/Dictionary_String_String_"},"createdBy":{"type":"string"},"fileName":{"type":"string"},"companyKey":{"type":"string"},"completedGroupOrder":{"type":"integer","format":"int32"}},"description":"SignedDocumentEventData","type":"object"},"Signee":{"title":"Signee","properties":{"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"fullAddress":{"type":"string"},"key":{"type":"string"},"signed":{"type":"boolean","x-nullable":false},"signedAt":{"type":"string","format":"date-time"},"processKey":{"type":"string"},"reason":{"type":"string"},"hidePersonalCode":{"type":"boolean","x-nullable":false},"communicationDeliveryType":{"type":"string"},"url":{"type":"string"},"signatureType":{"type":"string"},"language":{"type":"string"},"customSmsText":{"type":"string"},"status":{"type":"string"},"addedBy":{"type":"string"},"groupOrder":{"type":"integer","format":"int32"}},"description":"Signee","type":"object"},"SigningAttachment":{"title":"SigningAttachment","properties":{"fileName":{"type":"string"},"fileContent":{"type":"string"}},"description":"SigningAttachment","type":"object"},"AttachmentReference":{"title":"AttachmentReference","properties":{"id":{"type":"string"},"fileName":{"type":"string"},"contentLength":{"type":"integer","format":"int64","x-nullable":false},"contentType":{"type":"string"},"url":{"type":"string"},"description":{"type":"string"},"processKey":{"type":"string"},"attachmentType":{"type":"string"},"signeeKey":{"type":"string"}},"description":"AttachmentReference","type":"object"},"Dictionary_String_String_":{"title":"Dictionary<String,String>","additionalProperties":{"type":"string"},"description":"Dictionary<String,String>","type":"object"},"EventSignature":{"title":"EventSignature","properties":{"timeStamp":{"type":"integer","format":"int64","x-nullable":false},"guid":{"type":"string"},"signature":{"type":"string"},"signedData":{"type":"string"}},"description":"EventSignature","type":"object"},"SealingRequest":{"title":"SealingRequest","required":["pdfDocument","flowKey"],"properties":{"pdfDocument":{"description":"Base64String of the PDF document to seal","type":"string"},"flowKey":{"description":"A valid flowKey provided by Taktikal that can be used for sealing","type":"string"},"reason":{"description":"set the reason to display in the seal","type":"string"},"languageType":{"type":"string"},"addSealOnAllPages":{"description":"set to true to seal the document multiple times. One seal will be added per page.","type":"boolean","x-nullable":false},"archive":{"description":"Set to true to archive the document with PAdES-BASELINE-LTA (adds document timestamp and LTV data). Additional billing applies.","type":"boolean","x-nullable":false}},"description":"SealingRequest","type":"object"},"CreateSigningProcess":{"title":"CreateSigningProcess","required":["flowKey"],"properties":{"authIntoCreateSigningProcess":{"type":"boolean","x-nullable":false},"pdfDocument":{"description":"is a base64 string of the document to sign. This is not required if the flowKey takes care of creating the document.","type":"string"},"pdfFileName":{"description":"If PdfDocument is being used a value for the file name needs to be provided.","type":"string"},"flowKey":{"description":"FlowKey is provided by Taktikal. This key will tell Taktikal how to handle this request.\n            For some flowKeys Taktikal will take care of creating the document.\n            It will also control where the signed document is delivered after signing.","type":"string"},"createSignees":{"type":"array","items":{"$ref":"#/definitions/CreateSignee"}},"meta":{"$ref":"#/definitions/JsonAwareStringDictionary","description":"is a key-value store that is used to store additional data for this particular signingProcess.\n            The data here can be used to create the document if needed, and displayed in emails.\n            All data in meta is also delivered in the webhook response"},"attachments":{"type":"array","items":{"$ref":"#/definitions/SigningAttachment"}},"attachmentReferences":{"type":"array","items":{"$ref":"#/definitions/AttachmentReference"}},"requiresAuth":{"description":"Default value is false. If set to true then all signers need to use\n                    there e-Id to authenticate before being able to view the document. ","type":"boolean","x-nullable":false},"signInOrder":{"description":"Default value is false. Will control the order of signers.\n              It will only send a signing request to the first person in the signers list to begin with.\n              After he has signed the next signee and so on.","type":"boolean","x-nullable":false},"groupedOrderedSigning":{"description":"Default value is false. If set to true, signees are organized into groups by GroupOrder.\n              All signees in group 0 receive signing requests first. Once all in group 0 have signed,\n              group 1 receives requests, and so on. Cannot be combined with SignInOrder.","type":"boolean","x-nullable":false},"signatureLocation":{"description":"Can be BottomLastPage or the default value TopFirstPage. Will control where to display the signature in the document.","type":"string","enum":["NotSet","TopFirstPage","BottomLastPage"]},"user":{"description":"email address of the user that send the request. Can be empty.","type":"string"},"sequenceKey":{"type":"string"},"activityDisplayName":{"type":"string"},"flattenDocument":{"description":"Default value is false. If set to true then we will attempt to flatten the documents\n        input fields. ","type":"boolean","x-nullable":false},"reminderRule":{"description":"Sends reminders, leave empty for none. format should be \"firstReminder after x days:Then every y days\" e.g. \"1:3\" will send one reminder after 1 day, and then every three days after that. Leave empty or null for no reminders, valid values will be for first reminder to be sent between 0-30 days (0 means no reminder), and then send every 0-15 days (0, again, meaning no reminders, So 0:10 would only send reminder every 10 days, while 12:0 would send only one reminder after 12 days","type":"string"},"expireDate":{"type":"string","format":"date-time","x-nullable":false}},"description":"CreateSigningProcess","type":"object"},"CreateSignee":{"title":"CreateSignee","properties":{"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"reason":{"type":"string"},"hidePersonalCode":{"type":"boolean","x-nullable":false},"communicationDeliveryType":{"type":"string"},"customSmsText":{"type":"string"},"signatureType":{"type":"string"},"language":{"type":"string"},"addedBy":{"type":"string"},"passcode":{"type":"string"},"groupOrder":{"type":"integer","format":"int32"}},"description":"CreateSignee","type":"object"},"CancelSigningProcess":{"title":"CancelSigningProcess","properties":{"processKey":{"type":"string"},"user":{"type":"string"}},"description":"CancelSigningProcess","type":"object"},"ValidateApiKeys":{"title":"ValidateApiKeys","properties":{"flowKey":{"type":"string"},"webHookSignatureKey":{"type":"string"}},"description":"ValidateApiKeys","type":"object"},"MgmtGetFlow":{"title":"MgmtGetFlow","required":["flowKey"],"properties":{"flowKey":{"description":"The key for a specific flow","type":"string"}},"description":"MgmtGetFlow","type":"object"},"GetSmartFlowVersions":{"title":"GetSmartFlowVersions","properties":{"flowKey":{"type":"string"}},"description":"GetSmartFlowVersions","type":"object"},"DeleteWebhook":{"title":"DeleteWebhook","required":["id"],"properties":{"id":{"description":"The id of a webhook","type":"integer","format":"int32","x-nullable":false}},"description":"DeleteWebhook","type":"object"},"SealingXmlRequest":{"title":"SealingXmlRequest","required":["xmlDocument","flowKey"],"properties":{"xmlDocument":{"description":"Base64String of the XML document to seal","type":"string"},"flowKey":{"description":"A valid flowKey provided by Taktikal that can be used for sealing","type":"string"}},"description":"SealingXmlRequest","type":"object"},"CreateSequentialSigning":{"title":"CreateSequentialSigning","required":["createSigningProcesses","user"],"properties":{"createSigningProcesses":{"description":"List of signing processes. At least 1 signing process is required.","type":"array","items":{"$ref":"#/definitions/CreateSigningProcess"}},"user":{"description":"The user who starts the sequential signing process","type":"string"},"requiresAuth":{"description":"Default value is false. If set to true then all signers need to use\n                    there e-Id to authenticate before being able to view the document. ","type":"boolean","x-nullable":false},"signInOrder":{"description":"Default value is false. Will control the order of signers.\n              It will only send a signing request to the first person in the signers list to begin with.\n              After he has signed the next signee and so on.","type":"boolean","x-nullable":false},"expireDate":{"type":"string","format":"date-time","x-nullable":false}},"description":"CreateSequentialSigning","type":"object"},"CancelSequenceSigning":{"title":"CancelSequenceSigning","required":["sequenceKey","user"],"properties":{"sequenceKey":{"description":"Sequential signing process identifier that has to be provided.","type":"string"},"user":{"description":"Only the person who started the signing process can cancel it.","type":"string"}},"description":"CancelSequenceSigning","type":"object"},"GetSigningProcessExample":{"title":"GetSigningProcessExample","properties":{"flowKey":{"type":"string"}},"description":"GetSigningProcessExample","type":"object"},"Auth":{"title":"Auth","required":["phoneNumber","flowKey","lookupType"],"properties":{"phoneNumber":{"type":"string"},"flowKey":{"type":"string"},"lookupType":{"type":"string","enum":["NameAddress","Name","NameAddressFamily"]}},"description":"Auth","type":"object"},"AuthStart":{"title":"AuthStart","required":["flowKey","authenticationContextType"],"properties":{"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"flowKey":{"type":"string"},"authenticationContextType":{"type":"string","enum":["Sim","App"]},"includeVerificationCode":{"type":"boolean","x-nullable":false},"meta":{"$ref":"#/definitions/JsonAwareStringDictionary"}},"description":"AuthStart","type":"object"},"AuthPoll":{"title":"AuthPoll","required":["authRequestId","flowKey","lookupType"],"properties":{"authRequestId":{"type":"string"},"flowKey":{"type":"string"},"lookupType":{"type":"string","enum":["NameAddress","Name","NameAddressFamily"]}},"description":"AuthPoll","type":"object"},"IndividualComplianceStatusRequest":{"title":"IndividualComplianceStatusRequest","properties":{"ssn":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"}},"description":"IndividualComplianceStatusRequest","type":"object"},"BusinessComplianceStatusRequest":{"title":"BusinessComplianceStatusRequest","properties":{"ssn":{"type":"string"},"name":{"type":"string"}},"description":"BusinessComplianceStatusRequest","type":"object"},"MgmtFlowCssContent":{"title":"MgmtFlowCssContent","required":["flowKey"],"properties":{"flowKey":{"description":"The key for a specific flow","type":"string"}},"description":"MgmtFlowCssContent","type":"object"},"GetSmartFlowSchema":{"title":"GetSmartFlowSchema","properties":{"flowKey":{"type":"string"},"version":{"type":"string"}},"description":"GetSmartFlowSchema","type":"object"},"SaveSmartflowSchema":{"title":"SaveSmartflowSchema","properties":{"flowKey":{"type":"string"},"version":{"type":"string"},"schema":{"$ref":"#/definitions/Object"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"description":"SaveSmartflowSchema","type":"object"},"GetWebhooks":{"title":"GetWebhooks","required":["flowKey"],"properties":{"flowKey":{"description":"The flowKey to get all webhooks for","type":"string"},"type":{"description":"Can be empty to get all webhooks","type":"string","enum":["NotSet","SignedDocument","AllSigned","Auth","Signup","Canceled","Expired","Reminder","CompanyTermination","EmailVerification","Completed","Created","GroupSigned"]}},"description":"GetWebhooks","type":"object"},"SignDocumentStatusRequest":{"title":"SignDocumentStatusRequest","properties":{"token":{"type":"string"},"processKey":{"type":"string"},"signeeKey":{"type":"string"}},"description":"SignDocumentStatusRequest","type":"object"},"RequestToViewSequenceStart":{"title":"RequestToViewSequenceStart","required":["sequenceKey","authenticationContextType"],"properties":{"sequenceKey":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"authenticationContextType":{"type":"string","enum":["Sim","App"]},"includeVerificationCode":{"type":"boolean","x-nullable":false}},"description":"RequestToViewSequenceStart","type":"object"},"AddSequentialSignee":{"title":"AddSequentialSignee","required":["sequenceKey"],"properties":{"sequenceKey":{"type":"string"},"processKeys":{"description":"An array of processkeys within sequence to add signee to, If empty or null then all non-completed processkeys will be used","type":"array","items":{"type":"string"}},"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"reason":{"type":"string"},"hidePersonalCode":{"type":"boolean","x-nullable":false},"communicationDeliveryType":{"type":"string"},"customSmsText":{"type":"string"},"signatureType":{"type":"string"},"language":{"type":"string"},"addedBy":{"type":"string"},"passcode":{"type":"string"},"groupOrder":{"type":"integer","format":"int32"}},"description":"AddSequentialSignee","type":"object"},"UpdateSignee":{"title":"UpdateSignee","required":["signeeKey","processKey"],"properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"signeeKey":{"type":"string"},"processKey":{"type":"string"},"user":{"type":"string"}},"description":"UpdateSignee","type":"object"},"RemoveSignee":{"title":"RemoveSignee","required":["signeeKey","processKey"],"properties":{"signeeKey":{"type":"string"},"processKey":{"type":"string"},"user":{"type":"string"}},"description":"RemoveSignee","type":"object"},"GetSigningProcessBySignee":{"title":"GetSigningProcessBySignee","properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"userAgent":{"type":"string"}},"description":"GetSigningProcessBySignee","type":"object"},"RequestToViewPoll":{"title":"RequestToViewPoll","required":["processKey","authRequestId"],"properties":{"processKey":{"type":"string"},"authRequestId":{"type":"string"}},"description":"RequestToViewPoll","type":"object"},"FlowCssContent":{"title":"FlowCssContent","required":["flowKey"],"properties":{"flowKey":{"description":"The key for a specific flow","type":"string"}},"description":"FlowCssContent","type":"object"},"FlowFilter":{"title":"FlowFilter","required":["flowKey"],"properties":{"flowKey":{"description":"The key for a specific flow","type":"string"}},"description":"FlowFilter","type":"object"},"FlowCompanyFilter":{"title":"FlowCompanyFilter","properties":{},"description":"FlowCompanyFilter","type":"object"},"GetFlowDeliveries":{"title":"GetFlowDeliveries","required":["flowKey"],"properties":{"flowKey":{"description":"The key for a specific flow","type":"string"}},"description":"GetFlowDeliveries","type":"object"},"CheckDocumentSigningRequest":{"title":"CheckDocumentSigningRequest","required":["fileContent","fileName"],"properties":{"fileContent":{"description":"The content of a file","type":"string"},"fileName":{"description":"The filename including the type. Maximum 256 letters in length","type":"string"}},"description":"CheckDocumentSigningRequest","type":"object"},"GetPdfForSigningProcessPreview":{"title":"GetPdfForSigningProcessPreview","required":["processKey","signeeKey"],"properties":{"processKey":{"description":"The signing process key provided when create a signing process","type":"string"},"signeeKey":{"description":"The signee key representing a signer of the document ","type":"string"}},"description":"GetPdfForSigningProcessPreview","type":"object"},"RequestToViewSequencePoll":{"title":"RequestToViewSequencePoll","required":["sequenceKey","authRequestId"],"properties":{"sequenceKey":{"type":"string"},"authRequestId":{"type":"string"}},"description":"RequestToViewSequencePoll","type":"object"},"GetSequentialSigning":{"title":"GetSequentialSigning","properties":{"sequenceKey":{"type":"string"},"sequentialSigneeKey":{"type":"string"}},"description":"GetSequentialSigning","type":"object"},"UpdateSequentialSignee":{"title":"UpdateSequentialSignee","required":["sequentialSigneeKey","sequenceKey"],"properties":{"name":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"sequentialSigneeKey":{"type":"string"},"sequenceKey":{"type":"string"},"user":{"type":"string"}},"description":"UpdateSequentialSignee","type":"object"},"RemoveSequentialSignee":{"title":"RemoveSequentialSignee","required":["sequentialSigneeKey","sequenceKey"],"properties":{"sequentialSigneeKey":{"type":"string"},"sequenceKey":{"type":"string"},"user":{"type":"string"}},"description":"RemoveSequentialSignee","type":"object"},"CreateAttachmentReference":{"title":"CreateAttachmentReference","required":["processKey","signeeKey"],"properties":{"processKey":{"description":"The signing process key","type":"string"},"signeeKey":{"description":"The person who is signing key","type":"string"},"description":{"description":"The description of the attachment reference","type":"string"},"attachmentType":{"description":"AttachmentType, should be set to Unspecified","type":"string","enum":["Unspecified","LegacyAttachment","EvidencePage","PepPdf","PepPdfKeldan","PepJson","PepJsonKeldan","Verification","VerificationBankIdCz","XmlForSealing","VerificationMedia","CompanyInfo","CompanyPowerMeters","CompanyMoodysJson"]}},"description":"CreateAttachmentReference","type":"object"},"RequestToSign":{"title":"RequestToSign","required":["processKey","signeeKey"],"properties":{"processKey":{"description":"The signing process key","type":"string"},"signeeKey":{"description":"The person who is signing key","type":"string"},"otpType":{"description":"If the signature type is Simple (standard) or advanced, then the OTP request can be SMS or call.\n This setting is ignored for qualified signatures","type":"string"},"signatureContext":{"description":"If the signature type is a Qualified Signature then this will control\n    whether we use the App or Sim for signing. It defaults to Sim","type":"string","enum":["Sim","App"]}},"description":"RequestToSign","type":"object"},"RequestToViewPasscodeProcess":{"title":"RequestToViewPasscodeProcess","required":["processKey","signeeKey","passcode"],"properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"passcode":{"type":"string"}},"description":"RequestToViewPasscodeProcess","type":"object"},"UpdateSigningProcessMeta":{"title":"UpdateSigningProcessMeta","required":["processKey","signeeKey","meta"],"properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"meta":{"$ref":"#/definitions/JsonAwareStringDictionary","type":"object"},"skipDocumentUpdate":{"description":"if set to true we will not trigger a document recreation","type":"boolean","x-nullable":false}},"description":"UpdateSigningProcessMeta","type":"object"},"CreateSequenceAccessToken":{"title":"CreateSequenceAccessToken","required":["sequenceKey","sequentialSigneeKey"],"properties":{"sequenceKey":{"type":"string"},"sequentialSigneeKey":{"type":"string"},"expiresIn":{"description":"time in seconds of how long the token will be valid, default is 172800 (2 days)","type":"integer","format":"int32"}},"description":"CreateSequenceAccessToken","type":"object"},"GetAttachment":{"title":"GetAttachment","required":["id","processKey","fileName"],"properties":{"id":{"description":"The id of the reference ","type":"string"},"processKey":{"description":"The signing process key","type":"string"},"fileName":{"description":"The filename including the type","type":"string"}},"description":"GetAttachment","type":"object"},"DeleteAttachmentReference":{"title":"DeleteAttachmentReference","required":["id","processKey","fileName"],"properties":{"id":{"description":"The id of the reference to be deleted","type":"string"},"processKey":{"description":"The signing process key","type":"string"},"fileName":{"description":"The filename including the type","type":"string"}},"description":"DeleteAttachmentReference","type":"object"},"RequestToViewPasscodeSequence":{"title":"RequestToViewPasscodeSequence","required":["sequenceKey","sequentialSigneeKey","passcode"],"properties":{"sequenceKey":{"description":"Sequential signing process identifier that has to be provided.","type":"string"},"sequentialSigneeKey":{"description":"Sequential signing signee key identifier that has to be provided.","type":"string"},"passcode":{"description":"The passcode from the signee","type":"string"}},"description":"RequestToViewPasscodeSequence","type":"object"},"DeleteSigningReminder":{"title":"DeleteSigningReminder","required":["processKey","signeeKey","sequenceKey","sequenceSigneeKey"],"properties":{"processKey":{"description":"","type":"string"},"signeeKey":{"description":"","type":"string"},"sequenceKey":{"description":"","type":"string"},"sequenceSigneeKey":{"description":"","type":"string"}},"description":"DeleteSigningReminder","type":"object"},"SendSigningReminder":{"title":"SendSigningReminder","properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"user":{"type":"string"},"communicationDeliveryType":{"type":"string"},"includeUnsubscribe":{"type":"boolean","x-nullable":false}},"description":"SendSigningReminder","type":"object"},"CreateSigningProcessToken":{"title":"CreateSigningProcessToken","required":["processKey","signeeKey"],"properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"expiresIn":{"description":"time in seconds of how long the token will be valid, default is 172800 (2 days)","type":"integer","format":"int32"}},"description":"CreateSigningProcessToken","type":"object"},"RequestToBulkSign":{"title":"RequestToBulkSign","required":["sequenceKey","sequentialSigneeKey"],"properties":{"sequenceKey":{"type":"string"},"sequentialSigneeKey":{"type":"string"},"otpType":{"description":"The default value is sms but it can be set to call if needed. This is not used for click to sign","type":"string"}},"description":"RequestToBulkSign","type":"object"},"GlobalStatsDistanceAndTimeFilter":{"title":"GlobalStatsDistanceAndTimeFilter","required":["startDate","endDate"],"properties":{"startDate":{"description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time"},"endDate":{"description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time"},"minDistance":{"description":"The minimum distance traveled in meters","type":"integer","format":"int32"},"maxDistance":{"description":"The maximum distance traveled in meters","type":"integer","format":"int32"}},"description":"GlobalStatsDistanceAndTimeFilter","type":"object"},"CompanyStatsDistanceAndTimeFilter":{"title":"CompanyStatsDistanceAndTimeFilter","required":["publicCompanyKey","startDate","endDate"],"properties":{"publicCompanyKey":{"description":"The public company key that is provided in app.taktikal","type":"string"},"startDate":{"description":"Start date of the log to be searched, must be a smaller date than EndDate ","type":"string","format":"date-time"},"endDate":{"description":"End date of the log to be searched, must be a bigger date than StartDate ","type":"string","format":"date-time"},"minDistance":{"description":"The minimum distance traveled in meters","type":"integer","format":"int32"},"maxDistance":{"description":"The maximum distance traveled in meters","type":"integer","format":"int32"}},"description":"CompanyStatsDistanceAndTimeFilter","type":"object"},"WatchListRequestPublic":{"title":"WatchListRequestPublic","properties":{"countryCode":{"description":"Country code. example : US, SE etc","type":"string"},"firstName":{"description":"First Name - this field is mandatory (unless you are entering an OriginalName)","type":"string"},"middleName":{"description":"Middle name. Not available in all WatchListServices","type":"string"},"lastName":{"description":"Last Name - this field is mandatory (unless you are entering an OriginalName)","type":"string"},"originalName":{"description":"This parameter has multiple uses and supports either the individual's full name in original script text (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name if you are unable to separate based on first, middle and last Name. This field is mandatory, unless you are entering a first and last Name.","type":"string"},"dateOfBirth":{"description":"Date of birth (YYYY-MM-DD)","type":"string"},"gender":{"description":"Gender. Can be “Male” or “Female”. ","type":"string","enum":["Unknown","Female","Male"]},"matchRate":{"description":"A percentage from 1-99, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 99% being very close. Only applicable if matchType is Close","type":"integer","format":"int32","x-nullable":false},"matchType":{"description":"Used to determine how closely a watchlist entity must match a member before being considered a match. The options are Exact, ExactMidName or Close. Default is Exact.","type":"string"},"flowKey":{"description":"The Flow key connected to the query","type":"string"}},"description":"WatchListRequestPublic","type":"object"},"WatchListCompanyRequestPublic":{"title":"WatchListCompanyRequestPublic","properties":{"metadata":{"$ref":"#/definitions/MetadataPepCompany","description":"Search criteria"},"flowKey":{"description":"The Flow key connected to the query","type":"string"}},"description":"WatchListCompanyRequestPublic","type":"object"},"MetadataPepCompany":{"title":"MetadataPepCompany","required":["name"],"properties":{"country_code":{"description":"Country code. example : US, SE etc","type":"string"},"name":{"description":"Name","type":"string"},"scan_settings":{"$ref":"#/definitions/ScanSettingsCompany"}},"description":"MetadataPepCompany","type":"object"},"ScanSettingsCompany":{"title":"ScanSettingsCompany","properties":{"match_rate":{"type":"integer","format":"int32","x-nullable":false},"max_result_count":{"type":"integer","format":"int32","x-nullable":false}},"description":"ScanSettingsCompany","type":"object"},"Authenticate":{"title":"Authenticate","properties":{"provider":{"description":"AuthProvider, e.g. credentials","type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"rememberMe":{"type":"boolean"},"accessToken":{"type":"string"},"accessTokenSecret":{"type":"string"},"returnUrl":{"type":"string"},"errorView":{"type":"string"},"meta":{"$ref":"#/definitions/Dictionary_String_String_"}},"description":"Sign In","type":"object"},"ActivityLogTotal":{"title":"ActivityLogTotal","properties":{"total":{"type":"integer","format":"int32","x-nullable":false}},"description":"ActivityLogTotal","type":"object"},"SequentialSigning":{"title":"SequentialSigning","properties":{"key":{"type":"string"},"status":{"type":"string"},"requiresAuth":{"type":"boolean","x-nullable":false},"user":{"type":"string"},"signInOrder":{"type":"boolean","x-nullable":false},"signees":{"type":"array","items":{"$ref":"#/definitions/SequentialSigningSignee"}},"signingProcesses":{"type":"array","items":{"$ref":"#/definitions/SigningProcess"}},"currentSignee":{"type":"string"}},"description":"SequentialSigning","type":"object"},"SequentialSigningSignee":{"title":"SequentialSigningSignee","properties":{"key":{"type":"string"},"url":{"type":"string"},"signingKeys":{"type":"array","items":{"$ref":"#/definitions/SigneeKeys"}}},"description":"SequentialSigningSignee","type":"object"},"SigneeKeys":{"title":"SigneeKeys","properties":{"signeeKey":{"type":"string"},"processKey":{"type":"string"}},"description":"SigneeKeys","type":"object"},"SigningProcess":{"title":"SigningProcess","properties":{"key":{"type":"string"},"signees":{"type":"array","items":{"$ref":"#/definitions/Signee"}},"flowKey":{"type":"string"},"status":{"type":"string"},"meta":{"$ref":"#/definitions/JsonAwareStringDictionary"},"pdfFileName":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/SigningAttachment"}},"attachmentReferences":{"type":"array","items":{"$ref":"#/definitions/AttachmentReference"}},"requiresAuth":{"type":"boolean","x-nullable":false},"user":{"type":"string"},"signInOrder":{"type":"boolean","x-nullable":false},"groupedOrderedSigning":{"type":"boolean","x-nullable":false},"signatureLocation":{"type":"string"},"sequenceKey":{"type":"string"},"flattenDocument":{"type":"boolean","x-nullable":false},"expireDate":{"type":"string","format":"date-time","x-nullable":false}},"description":"SigningProcess","type":"object"},"ErrorResponse":{"title":"ErrorResponse","properties":{"responseStatus":{"$ref":"#/definitions/ResponseStatus"}},"description":"ErrorResponse","type":"object"},"ResponseStatus":{"title":"ResponseStatus","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"stackTrace":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/definitions/ResponseError"}},"meta":{"$ref":"#/definitions/Dictionary_String_String_"}},"description":"ResponseStatus","type":"object"},"ResponseError":{"title":"ResponseError","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"},"meta":{"$ref":"#/definitions/Dictionary_String_String_"}},"description":"ResponseError","type":"object"},"StartAuthResponse":{"title":"StartAuthResponse","properties":{"authRequestId":{"type":"string"},"verificationCode":{"type":"string"},"pollingInterval":{"type":"integer","format":"int32","x-nullable":false}},"description":"StartAuthResponse","type":"object"},"AuthPollIntoCreateProcessResult":{"title":"AuthPollIntoCreateProcessResult","properties":{"customer":{"$ref":"#/definitions/Customer"},"statusMessage":{"type":"string"},"waitingForUserInput":{"type":"boolean","x-nullable":false},"signingProcess":{"$ref":"#/definitions/SigningProcess"}},"description":"AuthPollIntoCreateProcessResult","type":"object"},"Customer":{"title":"Customer","properties":{"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"token":{"type":"string"},"flowKey":{"type":"string"},"meta":{"$ref":"#/definitions/Dictionary_String_String_"}},"description":"Customer","type":"object"},"SigningProcessActivityLogWrapper":{"title":"SigningProcessActivityLogWrapper","properties":{"processKey":{"type":"string"},"status":{"type":"string"},"activityLog":{"type":"array","items":{"$ref":"#/definitions/SigningProcessActivityLog"}},"signees":{"type":"array","items":{"$ref":"#/definitions/SigneeActivityLog"}},"sequenceSignees":{"type":"array","items":{"$ref":"#/definitions/SequentialSigningSigneeActivityLog"}},"attachmentReferences":{"type":"array","items":{"$ref":"#/definitions/AttachmentReference"}},"activityDisplayName":{"type":"string"},"fileName":{"type":"string"}},"description":"SigningProcessActivityLogWrapper","type":"object"},"SigningProcessActivityLog":{"title":"SigningProcessActivityLog","properties":{"id":{"type":"integer","format":"int32","x-nullable":false},"flowKey":{"type":"string"},"processKey":{"type":"string"},"signeeKey":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"},"userAgent":{"type":"string"},"fileName":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-nullable":false},"createdBy":{"type":"string"},"requiresAuth":{"type":"boolean"},"signInOrder":{"type":"boolean"},"signatureLocation":{"type":"string"},"sequenceKey":{"type":"string"}},"description":"SigningProcessActivityLog","type":"object"},"SigneeActivityLog":{"title":"SigneeActivityLog","properties":{"processKey":{"type":"string"},"signeeKey":{"type":"string"},"ssn":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-nullable":false},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time","x-nullable":false},"signatureType":{"type":"string"},"hasReminders":{"type":"boolean","x-nullable":false}},"description":"SigneeActivityLog","type":"object"},"SequentialSigningSigneeActivityLog":{"title":"SequentialSigningSigneeActivityLog","properties":{"sequenceKey":{"type":"string"},"signeeKey":{"type":"string"},"url":{"type":"string"},"signingKeys":{"type":"array","items":{"$ref":"#/definitions/SigneeKeys"}},"currentSignee":{"type":"string"}},"description":"SequentialSigningSigneeActivityLog","type":"object"},"List_SigningProcessActivityLogWrapper_":{"title":"List<SigningProcessActivityLogWrapper>","type":"array","items":{"$ref":"#/definitions/SigningProcessActivityLogWrapper"}},"ArchivingResponse":{"title":"ArchivingResponse","properties":{"pdfDocument":{"type":"string"},"fileName":{"type":"string"}},"description":"ArchivingResponse","type":"object"},"FlowOverview":{"title":"FlowOverview","properties":{"id":{"type":"integer","format":"int32","x-nullable":false},"key":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","x-nullable":false},"contract":{"type":"string"},"contractValues":{"type":"array","items":{"type":"string"}},"contractValuesAsString":{"type":"string"},"contractViewType":{"type":"string"},"authDisplayText":{"type":"string"},"contractAcceptanceText":{"type":"string"},"companyKey":{"type":"string"},"companyName":{"type":"string"},"type":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-nullable":false},"updatedAt":{"type":"string","format":"date-time","x-nullable":false},"canHaveAttachments":{"type":"boolean","x-nullable":false},"minNumberOfAttachments":{"type":"integer","format":"int32"},"productType":{"type":"string"},"initiatedType":{"type":"string"},"maxAdditionalSignees":{"type":"integer","format":"int32"},"minAdditionalSignees":{"type":"integer","format":"int32"},"activityDisplayName":{"type":"string"},"deleted":{"type":"boolean"},"signatureType":{"type":"string"},"languageType":{"type":"string"},"integrationId":{"type":"integer","format":"int32"},"requiredAuthType":{"type":"string"},"fileNameTemplate":{"type":"string"},"authScreenTitle":{"type":"string"},"authScreenDescription":{"type":"string"},"authScreenCountryCode":{"type":"string"},"defaultSignatureLocationType":{"type":"string"},"defaultReminderRule":{"type":"string"},"replyTo":{"type":"string"},"smartFlowPublishDate":{"type":"string","format":"date-time"},"smartFlowUpdatedDate":{"type":"string","format":"date-time"},"smartFlowHasChanges":{"type":"boolean"}},"description":"FlowOverview","type":"object"},"List_FlowOverview_":{"title":"List<FlowOverview>","type":"array","items":{"$ref":"#/definitions/FlowOverview"}},"SealingResponse":{"title":"SealingResponse","properties":{"pdfDocument":{"type":"string"},"sealingCount":{"type":"integer","format":"int32","x-nullable":false}},"description":"SealingResponse","type":"object"},"HttpResult":{"title":"HttpResult","properties":{"responseText":{"type":"string"},"responseStream":{"$ref":"#/definitions/Stream"},"fileInfo":{"$ref":"#/definitions/FileInfo"},"virtualFile":{"$ref":"#/definitions/IVirtualFile"},"contentType":{"type":"string"},"headers":{"$ref":"#/definitions/Dictionary_String_String_"},"cookies":{"type":"array","items":{"$ref":"#/definitions/Cookie"}},"eTag":{"type":"string"},"age":{"type":"string"},"maxAge":{"type":"string"},"expires":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"cacheControl":{"type":"integer","format":"int64"},"resultScope":{"$ref":"#/definitions/Func_IDisposable_"},"allowsPartialResponse":{"type":"boolean","x-nullable":false},"location":{"type":"string"},"options":{"$ref":"#/definitions/IDictionary_String_String_"},"status":{"type":"integer","format":"int32","x-nullable":false},"statusCode":{"type":"string"},"statusDescription":{"type":"string"},"response":{"$ref":"#/definitions/Object"},"responseFilter":{"$ref":"#/definitions/IContentTypeWriter"},"requestContext":{"$ref":"#/definitions/IRequest"},"view":{"type":"string"},"template":{"type":"string"},"paddingLength":{"type":"integer","format":"int32","x-nullable":false},"isPartialRequest":{"type":"boolean","x-nullable":false}},"description":"HttpResult","type":"object"},"Stream":{"title":"Stream","properties":{},"description":"Stream","type":"object"},"FileInfo":{"title":"FileInfo","properties":{},"description":"FileInfo","type":"object"},"IVirtualFile":{"title":"IVirtualFile","properties":{},"description":"IVirtualFile","type":"object"},"Cookie":{"title":"Cookie","properties":{},"description":"Cookie","type":"object"},"Func_IDisposable_":{"title":"Func`1","properties":{},"description":"Func<IDisposable>","type":"object"},"IDictionary_String_String_":{"title":"IDictionary<String,String>","additionalProperties":{"type":"string"},"description":"IDictionary<String,String>","type":"object"},"IContentTypeWriter":{"title":"IContentTypeWriter","properties":{},"description":"IContentTypeWriter","type":"object"},"IRequest":{"title":"IRequest","properties":{},"description":"IRequest","type":"object"},"Flow":{"title":"Flow","properties":{"key":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"active":{"type":"boolean","x-nullable":false},"contract":{"type":"string"},"contractValues":{"type":"array","items":{"type":"string"}},"contractValuesAsString":{"type":"string"},"authDisplayText":{"type":"string"},"companyId":{"type":"integer","format":"int32","x-nullable":false},"companyKey":{"type":"string"},"companyName":{"type":"string"},"contractAcceptanceText":{"type":"string"},"contractViewType":{"type":"string"},"type":{"type":"string"},"canHaveAttachments":{"type":"boolean","x-nullable":false},"minNumberOfAttachments":{"type":"integer","format":"int32"},"productType":{"type":"string"},"initiatedType":{"type":"string"},"maxAdditionalSignees":{"type":"integer","format":"int32"},"minAdditionalSignees":{"type":"integer","format":"int32"},"activityDisplayName":{"type":"string"},"deleted":{"type":"boolean"},"signatureType":{"type":"string"},"languageType":{"type":"string"},"integrationId":{"type":"integer","format":"int32"},"requiredAuthType":{"type":"string"},"fileNameTemplate":{"type":"string"},"authScreenTitle":{"type":"string"},"authScreenDescription":{"type":"string"},"authScreenCountryCode":{"type":"string"},"defaultSignatureLocationType":{"type":"string"},"defaultReminderRule":{"type":"string"},"replyTo":{"type":"string"}},"description":"Flow","type":"object"},"SmartFlowSchemaVersion":{"title":"SmartFlowSchemaVersion","properties":{"version":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-nullable":false},"updatedAt":{"type":"string","format":"date-time","x-nullable":false}},"description":"SmartFlowSchemaVersion","type":"object"},"List_SmartFlowSchemaVersion_":{"title":"List<SmartFlowSchemaVersion>","type":"array","items":{"$ref":"#/definitions/SmartFlowSchemaVersion"}},"CreateSigningProcessExample":{"title":"CreateSigningProcessExample","properties":{"meta":{"$ref":"#/definitions/Dictionary_String_Object_"},"createSignees":{"type":"array","items":{"$ref":"#/definitions/CreateSigneeExample"}},"requiresAuth":{"type":"string"},"pdfDocument":{"type":"string"},"pdfFileName":{"type":"string"},"signatureLocation":{"type":"string"},"flattenDocument":{"type":"string"},"expireDate":{"type":"string"},"flowKey":{"type":"string"},"reminderRule":{"type":"string"}},"description":"CreateSigningProcessExample","type":"object"},"Dictionary_String_Object_":{"title":"Dictionary<String,Object>","additionalProperties":{"$ref":"#/definitions/Object"},"description":"Dictionary<String,Object>","type":"object"},"CreateSigneeExample":{"title":"CreateSigneeExample","properties":{"name":{"type":"string"},"ssn":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"reason":{"type":"string"},"hidePersonalCode":{"type":"string"},"communicationDeliveryType":{"type":"string"},"customSmsText":{"type":"string"},"signatureType":{"type":"string"},"language":{"type":"string"}},"description":"CreateSigneeExample","type":"object"},"PollCustomer":{"title":"PollCustomer","properties":{"customer":{"$ref":"#/definitions/Customer"},"statusMessage":{"type":"string"},"waitingForUserInput":{"type":"boolean","x-nullable":false}},"description":"PollCustomer","type":"object"},"IndividualComplianceStatus":{"title":"IndividualComplianceStatus","properties":{"pep_found":{"type":"boolean","x-nullable":false},"status":{"type":"string"},"status_messages":{"type":"array","items":{"type":"string"}},"requirements":{"type":"array","items":{"$ref":"#/definitions/Requirement"}},"is_compliant":{"type":"boolean","x-nullable":false}},"description":"IndividualComplianceStatus","type":"object"},"Requirement":{"title":"Requirement","properties":{"compliance_type":{"type":"string"},"answered_date":{"type":"string","format":"date-time"},"next_date":{"type":"string","format":"date-time"},"flow_key":{"type":"string"}},"description":"Requirement","type":"object"},"BusinessComplianceStatus":{"title":"BusinessComplianceStatus","properties":{"status":{"type":"string"},"status_messages":{"type":"array","items":{"type":"string"}},"requirements":{"type":"array","items":{"$ref":"#/definitions/Requirement"}},"is_compliant":{"type":"boolean","x-nullable":false}},"description":"BusinessComplianceStatus","type":"object"},"FlowCustomCss":{"title":"FlowCustomCss","properties":{"flowKey":{"type":"string"},"content":{"type":"string"},"createdAt":{"type":"string","format":"date-time","x-nullable":false}},"description":"FlowCustomCss","type":"object"},"SmartFlowSchema":{"title":"SmartFlowSchema","properties":{"schema":{"type":"string","x-nullable":false},"createdAt":{"type":"string","format":"date-time","x-nullable":false},"updatedAt":{"type":"string","format":"date-time","x-nullable":false}},"description":"SmartFlowSchema","type":"object"},"List_Webhook_":{"title":"List<Webhook>","type":"array","items":{"$ref":"#/definitions/Webhook"}},"SignDocumentStatusResponse":{"title":"SignDocumentStatusResponse","properties":{"control_code":{"type":"string"},"error_code":{"type":"string"},"file":{"$ref":"#/definitions/FileSign"},"message":{"type":"string"},"signature_context_type":{"type":"string"},"status":{"type":"string"},"token":{"type":"string"}},"description":"SignDocumentStatusResponse","type":"object"},"FileSign":{"title":"FileSign","properties":{"content":{"type":"string"},"digest":{"type":"string"},"fileName":{"type":"string"}},"description":"FileSign","type":"object"},"RequestToViewPollResult":{"title":"RequestToViewPollResult","properties":{"process":{"$ref":"#/definitions/SigningProcess"},"waitingForUserInput":{"type":"boolean","x-nullable":false}},"description":"RequestToViewPollResult","type":"object"},"FlowDeliveries":{"title":"FlowDeliveries","properties":{"emailTemplateTypes":{"type":"array","items":{"type":"string"}},"webhookTypes":{"type":"array","items":{"type":"string"}}},"description":"FlowDeliveries","type":"object"},"CheckDocumentSigningResponse":{"title":"CheckDocumentSigningResponse","properties":{"status":{"type":"string"},"message":{"type":"string"},"error_code":{"type":"string"},"structure":{"$ref":"#/definitions/CheckDocumentSigningStructure"}},"description":"CheckDocumentSigningResponse","type":"object"},"CheckDocumentSigningStructure":{"title":"CheckDocumentSigningStructure","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/CheckDocumentSigningContent"}},"signatures":{"type":"array","items":{"$ref":"#/definitions/CheckDocumentSigningSignatures"}},"standard":{"type":"string"},"category":{"type":"string"},"is_valid":{"type":"boolean","x-nullable":false},"valid_to":{"type":"string","format":"date-time","x-nullable":false},"can_flatten":{"type":"boolean","x-nullable":false}},"description":"CheckDocumentSigningStructure","type":"object"},"CheckDocumentSigningContent":{"title":"CheckDocumentSigningContent","properties":{"id":{"type":"string"},"name":{"type":"string"},"size":{"type":"string"},"mimetype":{"type":"string"},"type":{"type":"string"}},"description":"CheckDocumentSigningContent","type":"object"},"CheckDocumentSigningSignatures":{"title":"CheckDocumentSigningSignatures","properties":{"id":{"type":"string"},"signing_time":{"type":"string","format":"date-time","x-nullable":false},"signature_timestamp_time":{"type":"string","format":"date-time","x-nullable":false},"grace_period_end_time":{"type":"string","format":"date-time","x-nullable":false},"signing_purpose":{"type":"string"},"certificate":{"$ref":"#/definitions/CheckDocumentSigningCertificate"},"metadata":{"$ref":"#/definitions/CheckDocumentSigningMetadata"},"is_ltv_timestamp":{"type":"boolean","x-nullable":false},"is_archived":{"type":"boolean","x-nullable":false},"is_valid":{"type":"boolean","x-nullable":false},"valid_to":{"type":"string","format":"date-time","x-nullable":false},"signature_value":{"type":"string"}},"description":"CheckDocumentSigningSignatures","type":"object"},"CheckDocumentSigningCertificate":{"title":"CheckDocumentSigningCertificate","properties":{"name":{"type":"string"},"subject":{"$ref":"#/definitions/CheckDocumentSigningSubject"},"issuer":{"$ref":"#/definitions/CheckDocumentSigningIssuer"},"valid_from":{"type":"string","format":"date-time","x-nullable":false},"valid_to":{"type":"string","format":"date-time","x-nullable":false},"value":{"type":"string"}},"description":"CheckDocumentSigningCertificate","type":"object"},"CheckDocumentSigningSubject":{"title":"CheckDocumentSigningSubject","properties":{"organisation_unit":{"type":"string"},"country":{"type":"string"},"serial_number":{"type":"string"},"common_name":{"type":"string"}},"description":"CheckDocumentSigningSubject","type":"object"},"CheckDocumentSigningIssuer":{"title":"CheckDocumentSigningIssuer","properties":{"organisation":{"type":"string"},"organisation_unit":{"type":"string"},"country":{"type":"string"},"serial_number":{"type":"string"},"common_name":{"type":"string"}},"description":"CheckDocumentSigningIssuer","type":"object"},"CheckDocumentSigningMetadata":{"title":"CheckDocumentSigningMetadata","properties":{"contact":{"type":"string"},"reason":{"type":"string"},"location":{"type":"string"}},"description":"CheckDocumentSigningMetadata","type":"object"},"GetPdfForPreviewResponse":{"title":"GetPdfForPreviewResponse","properties":{"responseStatus":{"$ref":"#/definitions/ResponseStatus"}},"description":"GetPdfForPreviewResponse","type":"object"},"RequestToViewSequencePollResult":{"title":"RequestToViewSequencePollResult","properties":{"sequence":{"$ref":"#/definitions/SequentialSigning"},"waitingForUserInput":{"type":"boolean","x-nullable":false}},"description":"RequestToViewSequencePollResult","type":"object"},"SignDocumentResponse":{"title":"SignDocumentResponse","properties":{"control_code":{"type":"string"},"error_code":{"type":"string"},"lockedBy":{"type":"string"},"message":{"type":"string"},"signature_type":{"type":"string"},"status":{"type":"string"},"token":{"type":"string"},"valid_until":{"type":"string","format":"date-time","x-nullable":false},"processKey":{"type":"string"},"signeeKey":{"type":"string"}},"description":"SignDocumentResponse","type":"object"},"TaktikalAccessToken":{"title":"TaktikalAccessToken","properties":{"accessToken":{"type":"string"},"tokenType":{"type":"string"},"expiresIn":{"type":"integer","format":"int32","x-nullable":false},"expiresAt":{"type":"string","format":"date-time","x-nullable":false},"scope":{"type":"string"}},"description":"TaktikalAccessToken","type":"object"},"BulkSignDocumentResponse":{"title":"BulkSignDocumentResponse","properties":{"control_code":{"type":"string"},"error_code":{"type":"string"},"lockedBy":{"type":"string"},"message":{"type":"string"},"signature_type":{"type":"string"},"status":{"type":"string"},"token":{"type":"string"},"valid_until":{"type":"string","format":"date-time","x-nullable":false},"sequenceKey":{"type":"string"},"sequenceSigneeKey":{"type":"string"}},"description":"BulkSignDocumentResponse","type":"object"},"StatsDistanceAndTimeResult":{"title":"StatsDistanceAndTimeResult","properties":{"totalDistance":{"type":"integer","format":"int64","x-nullable":false},"totalTime":{"type":"integer","format":"int64","x-nullable":false},"avgDistance":{"type":"number","format":"double","x-nullable":false},"avgTime":{"type":"number","format":"double","x-nullable":false},"totalTrips":{"type":"integer","format":"int32","x-nullable":false},"startDate":{"type":"string","format":"date-time"},"endDate":{"type":"string","format":"date-time"}},"description":"StatsDistanceAndTimeResult","type":"object"},"WatchListResponse":{"title":"WatchListResponse","properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/Error"}},"id":{"type":"array","items":{"$ref":"#/definitions/ResponseIds"}},"date":{"type":"array","items":{"$ref":"#/definitions/ResponseDates"}},"match":{"type":"array","items":{"$ref":"#/definitions/Match"}},"status":{"type":"array","items":{"$ref":"#/definitions/ResponseStatus"}},"flowkey":{"type":"string"},"request":{"$ref":"#/definitions/WatchListRequest"},"companyRequest":{"$ref":"#/definitions/WatchListCompanyRequest"},"numberOfMatches":{"type":"number","format":"double"}},"description":"WatchListResponse","type":"object"},"Error":{"title":"Error","properties":{"code":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"statusCode":{"type":"integer","format":"int32"},"serviceType":{"type":"string"}},"description":"Error","type":"object"},"ResponseIds":{"title":"ResponseIds","properties":{"id":{"type":"string"},"lookupType":{"type":"string"}},"description":"ResponseIds","type":"object"},"ResponseDates":{"title":"ResponseDates","properties":{"date":{"type":"string","format":"date-time","x-nullable":false},"lookupType":{"type":"string"}},"description":"ResponseDates","type":"object"},"Match":{"title":"Match","properties":{"category":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"match_rate":{"type":"number","format":"double"},"matchType":{"type":"string"},"hitRating":{"type":"integer","format":"int32"},"keyWordHitRating":{"type":"number","format":"double"},"matchedFields":{"type":"array","items":{"type":"string"}},"flag":{"type":"number","format":"double"},"lookupType":{"type":"string"},"uniqueId":{"type":"string"},"subcategory":{"type":"string"},"gender":{"type":"string"},"deceased":{"type":"boolean","x-nullable":false},"deceasedDate":{"type":"string"},"title":{"type":"string"},"firstName":{"type":"string"},"companyName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"fullName":{"type":"string"},"image":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"position":{"type":"string"},"dateOfBirth":{"type":"string"},"countries":{"type":"array","items":{"$ref":"#/definitions/Country"}},"placeOfBirth":{"type":"string"},"primaryLocation":{"type":"string"},"generalInfo":{"$ref":"#/definitions/GeneralInformation"},"furtherInformation":{"type":"array","items":{"type":"string"}},"descriptions":{"type":"array","items":{"$ref":"#/definitions/Description"}},"enterDate":{"type":"string"},"lastReviewed":{"type":"string"},"nameDetails":{"type":"array","items":{"$ref":"#/definitions/NameDetail"}},"originalScriptNames":{"type":"array","items":{"type":"string"}},"roles":{"type":"array","items":{"$ref":"#/definitions/Role"}},"importantDates":{"type":"array","items":{"$ref":"#/definitions/Date"}},"locations":{"type":"array","items":{"$ref":"#/definitions/Location"}},"officialLists":{"type":"array","items":{"$ref":"#/definitions/OfficialList"}},"idNumbers":{"type":"array","items":{"$ref":"#/definitions/IDNumber"}},"linkedIndividuals":{"type":"array","items":{"$ref":"#/definitions/LinkedIndividual"}},"linkedCompanies":{"type":"array","items":{"$ref":"#/definitions/LinkedCompany"}},"sources":{"type":"array","items":{"$ref":"#/definitions/Source"}},"jurisdictionRiskResults":{"type":"array","items":{"$ref":"#/definitions/JurisdictionRiskResult"}}},"description":"Match","type":"object"},"Country":{"title":"Country","properties":{"type":{"type":"string"},"value":{"type":"string"}},"description":"Country","type":"object"},"GeneralInformation":{"title":"GeneralInformation","properties":{"nationality":{"type":"string"},"alternateTitle":{"type":"string"},"businessDescription":{"type":"string"},"website":{"type":"string"}},"description":"GeneralInformation","type":"object"},"Description":{"title":"Description","properties":{"description1":{"type":"string"},"description2":{"type":"string"},"description3":{"type":"string"}},"description":"Description","type":"object"},"NameDetail":{"title":"NameDetail","properties":{"type":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"companyName":{"type":"string"}},"description":"NameDetail","type":"object"},"Role":{"title":"Role","properties":{"title":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"}},"description":"Role","type":"object"},"Date":{"title":"Date","properties":{"type":{"type":"string"},"value":{"type":"string"}},"description":"Date","type":"object"},"Location":{"title":"Location","properties":{"country":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"countryCode":{"type":"string"}},"description":"Location","type":"object"},"OfficialList":{"title":"OfficialList","properties":{"keyword":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"},"country":{"type":"string"},"isCurrent":{"type":"boolean"},"isActive":{"type":"boolean"},"origin":{"type":"string"},"types":{"type":"string"},"measures":{"type":"string"}},"description":"OfficialList","type":"object"},"IDNumber":{"title":"IDNumber","properties":{"type":{"type":"string"},"idNotes":{"type":"string"},"number":{"type":"string"}},"description":"IDNumber","type":"object"},"LinkedIndividual":{"title":"LinkedIndividual","properties":{"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"category":{"type":"string"},"otherCategories":{"type":"string"},"subcategories":{"type":"string"},"description":{"type":"string"},"recordId":{"type":"integer","format":"int64","x-nullable":false}},"description":"LinkedIndividual","type":"object"},"LinkedCompany":{"title":"LinkedCompany","properties":{"name":{"type":"string"},"categories":{"type":"string"},"subcategories":{"type":"string"},"description":{"type":"string"},"category":{"type":"string"},"recordId":{"type":"integer","format":"int64","x-nullable":false}},"description":"LinkedCompany","type":"object"},"Source":{"title":"Source","properties":{"url":{"type":"string"},"cachedUrl":{"type":"string"},"categories":{"type":"array","items":{"type":"string"}},"dates":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"description":"Source","type":"object"},"JurisdictionRiskResult":{"title":"JurisdictionRiskResult","properties":{"jurisdiction":{"type":"string"},"effectivenessScore":{"type":"integer","format":"int32","x-nullable":false},"effectivenessLevel":{"type":"integer","format":"int32","x-nullable":false},"complianceScore":{"type":"integer","format":"int32","x-nullable":false},"complianceLevel":{"type":"integer","format":"int32","x-nullable":false},"comments":{"type":"string"},"fatfCompliance":{"type":"string"},"fatfComplianceNotes":{"type":"string"},"fatfEffectiveness":{"type":"string"},"fatfEffectivenessNotes":{"type":"string"},"fatfEffectivenessSubtitles":{"type":"string"},"countryCode":{"type":"string"}},"description":"JurisdictionRiskResult","type":"object"},"WatchListRequest":{"title":"WatchListRequest","properties":{"countryCode":{"description":"Country code. example : US, SE etc","type":"string"},"firstName":{"description":"First Name - this field is mandatory (unless you are entering an OriginalName)","type":"string"},"middleName":{"description":"Middle name. Not available in all WatchListServices","type":"string"},"lastName":{"description":"Last Name - this field is mandatory (unless you are entering an OriginalName)","type":"string"},"originalName":{"description":"This parameter has multiple uses and supports either the individual's full name in original script text (e.g. Cyrillic, Arabic, Chinese etc), or the full Latin-based name if you are unable to separate based on first, middle and last Name. This field is mandatory, unless you are entering a first and last Name.","type":"string"},"dateOfBirth":{"description":"Date of birth (YYYY-MM-DD)","type":"string"},"gender":{"description":"Gender. Can be “Male” or “Female”. ","type":"string","enum":["Unknown","Female","Male"]},"personalNumber":{"description":"PersonalNumber is optional and only available in Nordic, use together with CountryCode. The NORDIC provider has all persons in PEP listed with PersonalNumber so this parameter is a recommendation for perfect PEP match rate in the Nordic countries.","type":"string"},"matchRate":{"description":"A percentage from 1-99, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 99% being very close. Only applicable if matchType is Close","type":"integer","format":"int32","x-nullable":false},"matchType":{"description":"Used to determine how closely a watchlist entity must match a member before being considered a match. The options are Exact, ExactMidName or Close. Default is Exact.","type":"string"},"watchListServices":{"description":"List of Watch List services to include in the search. Each service has a usage price. At least one service must be selected","type":"array","items":{"type":"string","x-nullable":false}},"flowKey":{"description":"The Flow key connected to the query","type":"string"}},"description":"WatchListRequest","type":"object"},"WatchListCompanyRequest":{"title":"WatchListCompanyRequest","properties":{"metadata":{"$ref":"#/definitions/MetadataPepCompany","description":"Search criteria"},"relayState":{"description":"Optional Custom Parameter to be included in webhook calls","type":"string"},"webhook":{"description":"A webhook in web development is a method of augmenting or altering the behavior of a web page or web application with custom callbacks","type":"string"},"flowKey":{"description":"The Flow key connected to the query","type":"string"}},"description":"WatchListCompanyRequest","type":"object"},"AuthenticateResponse":{"title":"AuthenticateResponse","properties":{"userId":{"type":"string"},"sessionId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"referrerUrl":{"type":"string"},"bearerToken":{"type":"string"},"refreshToken":{"type":"string"},"refreshTokenExpiry":{"type":"string","format":"date-time"},"profileUrl":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"authProvider":{"type":"string"},"responseStatus":{"$ref":"#/definitions/ResponseStatus"},"meta":{"$ref":"#/definitions/Dictionary_String_String_"}},"description":"AuthenticateResponse","type":"object"}},"parameters":{"Accept":{"name":"Accept","in":"header","description":"Accept Header","type":"string","required":true,"enum":["application/json"]}},"securityDefinitions":{"basic":{"type":"basic"}},"tags":[{"name":"auth","description":"ApiResource: Auth"},{"name":"compliance","description":"ApiResource: Compliance"},{"name":"document archiving"},{"name":"document sealing","description":"ApiResource: Sealing"},{"name":"flow","description":"ApiResource: Flow"},{"name":"pdf","description":"ApiResource: Pdf"},{"name":"signing","description":"ApiResource: Signing"},{"name":"signing activity","description":"ApiResource: Signing"},{"name":"signing process attachment"},{"name":"statistics","description":"ApiResource: Statistics"},{"name":"watchlist"},{"name":"webhook","description":"ApiResource: WebHook"}]}