{
"paths": {
"/identification/session": {
"get": {
"tags": [
"Identification Session"
],
"summary": "Retrieve session response",
"description": "Retrieves the response of a single identifaction session.\r\nREMARK: Only authenticate users when the identitication status is equal to SUCCESS.",
"operationId": "identification/RetrieveSessionResponse",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "The unique identifier returned in the creation of the session",
"required": true,
"type": "string"
},
{
"name": "metaData",
"in": "query",
"description": "Whether metadata should be included in the response, only set to true if needed (addons and user ceritifcate)",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentificationResponse"
}
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Identification Session"
],
"summary": "Create session",
"description": "Creates a new identification session",
"operationId": "identification/CreateSession",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateIdentificationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateIdentificationResponse"
}
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/identification/session/status": {
"get": {
"tags": [
"Identification Session"
],
"summary": "Retrieve session status",
"description": "Retrieves the status of a single identification session.",
"operationId": "identification/RetrieveSessionStatus",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "requestId",
"in": "query",
"description": "The requestId returned in the creation of the request",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentificationCompleteResponse"
}
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/identification/session/invalidate": {
"put": {
"tags": [
"Identification Session"
],
"summary": "Invalidate session",
"description": "Invalidates an identification session to avoid using the same request twice. Remark: if the session has status ERROR it will not be invalidated.",
"operationId": "identification/InvalidateSession",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "value",
"in": "body",
"description": "A request object",
"required": true,
"schema": {
"$ref": "#/definitions/InvalidateIdentificationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/identification/log/requestId/{requestId}": {
"get": {
"tags": [
"Log"
],
"summary": "Retrieve a log entry",
"description": "Gets an historic identification session (older than 14 days)\r\nRemark: Log entries are updated with a little delay (min 5 minutes max 25 minutes).",
"operationId": "identification/RetrieveALogEntry",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "A request object",
"required": true,
"type": "string"
},
{
"name": "accountId",
"in": "query",
"description": "If dealer with multiple accounts. Specify accountId for the session, otherwise ignore",
"required": false,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IdentificationLogItem"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/identification/log/filter/{year}": {
"get": {
"tags": [
"Log"
],
"summary": "List log entries",
"description": "Gets an list of historic identification sessions (older than 14 days) by the filter below fetched the last 1000 with a link to next page. \r\nRemark: Log entries are updated with a little delay (min 5 minutes max 25 minutes).",
"operationId": "identification/ListLogEntries",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "year",
"in": "path",
"description": "The year to fetch the sessions from",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "month",
"in": "query",
"description": "Optional: Filter on month",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "day",
"in": "query",
"description": "Optional: Filter on day",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "status",
"in": "query",
"description": "Optional: Filter on status",
"required": false,
"type": "string",
"enum": [
"UNKNOWN",
"SUCCESS",
"ERROR",
"USERABORTED",
"INVALIDATED",
"TIMEOUT",
"CREATED",
"USERINITIATED"
]
},
{
"name": "identityProviderType",
"in": "query",
"description": "Optional: Filter on identity provider",
"required": false,
"type": "string",
"enum": [
"UNKNOWN",
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"SWE_BANKID_MOBILE",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"FI_MOBIILIVARMENNE",
"BE_ITSME",
"FI_FTN"
]
},
{
"name": "externalId",
"in": "query",
"description": "The merchants reference to the identification process",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"description": "Optional: Filter on the name of the user",
"required": false,
"type": "string"
},
{
"name": "skip",
"in": "query",
"description": "Number of pages to skip",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"description": "Number of results in each page (max 1000)",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ListResult[IdentificationLogItem]"
}
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/identification/no/bankid/mobile": {
"post": {
"tags": [
"Norwegian BankID"
],
"summary": "Create mobile session",
"description": "Creates a new BankID mobile session to start the identification process. Returns request ID and a merchant reference.\r\nIf the user does not have BankID mobile or invalid data was input, this will be indicated by the InvalidMobileNumberOrDateOfBirth parameter being returned as true.\r\nIf an error occured, the response will contain an error object with an error code and error message.",
"operationId": "identification/CreateMobileSession",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "model",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateBankIDMobileRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateBankIDMobileResponse"
}
},
"400": {
"description": "Bad Request (One or more of the required properties are missing or are in a wrong format)"
},
"401": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"oauth2": [
"identify"
]
}
],
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/attachments": {
"get": {
"tags": [
"Attachments"
],
"summary": "List attachments",
"description": "Returns a list of all attachments for the specified document.",
"operationId": "signature/ListAttachments",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/AttachmentListItem"
}
},
"examples": {
"application/json": [
{
"id": "bef00156-87d8-450e-addc-bfa5d9be89a6",
"title": "Attachment 1 - Type description",
"description": "This attachment describes bla bla bla...",
"type": "show_accept",
"fileName": "Attachment1.pdf"
},
{
"id": "ef3f0775-9373-4c00-98b5-c0080a59b4b2",
"title": "Attachment 2 - Building sketches",
"description": "This attachment includes sketches of the build at...",
"type": "show_accept",
"fileName": "Attachment2.pdf"
}
]
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Attachments"
],
"summary": "Create attachment",
"description": "Adds an attachments to the specified document. You can choose between different ways to make the user accept the attachment.\r\n The attachment will be deleted when the signature job is completed or has expired",
"operationId": "signature/CreateAttachment",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/AttachmentRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AttachmentResponse"
},
"examples": {
"application/json": {
"id": "84783d0f-2205-4170-98a4-0819bc0d89df",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
},
"201": {
"description": ""
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/attachments/{attachmentId}": {
"get": {
"tags": [
"Attachments"
],
"summary": "Retrieve attachment",
"description": "Retrieves the details of a single attachment.",
"operationId": "signature/RetrieveAttachment",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AttachmentResponse"
},
"examples": {
"application/json": {
"id": "97621289-55db-4b77-a125-2bc1a6c63202",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Attachments"
],
"summary": "Delete attachment",
"description": "Deletes the specified attachment (Will only take affect if no one has signed the document yet)",
"operationId": "signature/DeleteAttachment",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Attachments"
],
"summary": "Update attachment",
"description": "Updates the specified attachment (Will only take affect if no one has signed the document yet)",
"operationId": "signature/UpdateAttachment",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateAttachmentRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AttachmentResponse"
},
"examples": {
"application/json": {
"id": "058ef2a9-0659-4783-8a39-9a3bc958e89f",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents": {
"post": {
"tags": [
"Documents"
],
"summary": "Create document",
"description": "Creates a new document. In the response you will receive a document ID to retrieve info about the document at a later time. \r\nYou also receive a URL and unique identifier per signer.",
"operationId": "signature/CreateDocument",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/CreateDocumentRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDocumentResponse"
},
"examples": {
"application/json": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "f8c6230c-887f-40bf-9438-ab7d005fea5f",
"links": [],
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"formFields": [],
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"tags": [],
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"status": {
"documentStatus": "unsigned",
"completedPackages": [],
"attachmentPackages": {}
},
"links": [],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://idfy.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2020-03-14T05:49:13Z",
"deleteAfterHours": 1
}
}
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document",
"description": "Retrieves details of a single document.",
"operationId": "signature/RetrieveDocument",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDocumentResponse"
},
"examples": {
"application/json": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "daf5bafb-ac0d-40b1-a5a0-ab7d005fea5f",
"links": [],
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"formFields": [],
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"tags": [],
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"status": {
"documentStatus": "unsigned",
"completedPackages": [],
"attachmentPackages": {}
},
"links": [],
"title": "Test document",
"description": "This is an important document",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://idfy.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2020-03-14T05:49:13Z",
"deleteAfterHours": 1
}
}
}
}
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Documents"
],
"summary": "Update document",
"description": "Include the properties/fields you want to update in your request",
"operationId": "signature/UpdateDocument",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateDocumentRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDocumentResponse"
},
"examples": {
"application/json": {
"documentId": "94865b6f-2aa9-436d-8b3c-a85e00efd034",
"signers": [
{
"id": "3291aad2-d12b-4a72-9645-ab7d005fea62",
"links": [],
"ui": {
"dialogs": {
"before": {
"useCheckBox": false,
"formFields": [],
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"language": "EN",
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"tags": [],
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"status": {
"documentStatus": "unsigned",
"completedPackages": [],
"attachmentPackages": {}
},
"links": [],
"title": "Updated title",
"description": "This is an updated description",
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"dataToSign": {
"title": "Document title",
"description": "Document description",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://idfy.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2020-03-14T05:49:13Z",
"deleteAfterHours": 1
}
}
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/cancel": {
"post": {
"tags": [
"Documents"
],
"summary": "Cancel document",
"description": "Cancel a document, after a document is canceled it cannot be signed. The signer will be presented the reason if they click the sign-url",
"operationId": "signature/CancelDocument",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "reason",
"in": "query",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/status": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document status",
"description": "Get the status of a document",
"operationId": "signature/RetrieveDocumentStatus",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Status"
},
"examples": {
"application/json": {
"documentStatus": "signed",
"completedPackages": [
"standard_packaging",
"pades"
],
"attachmentPackages": {}
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/summary": {
"get": {
"tags": [
"Documents"
],
"summary": "Retrieve document summary",
"description": "Get information about a document",
"operationId": "signature/RetrieveDocumentSummary",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/DocumentSummary"
},
"examples": {
"application/json": {
"documentId": "472ba28b-beef-4d9a-a44e-bd34929c0b73",
"accountId": "c380a7b2-d918-4548-9797-948d0efa5051",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2020-03-11T18:49:13Z",
"deadline": "2020-03-17T05:49:13Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "3ef8b706-a8e0-4903-ba19-d5b201cd5ff6",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2020-03-13T00:49:13Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"ecc645d5-96d9-406d-8ae8-8e6351fef079"
],
"signers": [
"3ef8b706-a8e0-4903-ba19-d5b201cd5ff6",
"0a362918-7373-4fbc-9495-f393b3a848ae"
],
"created": "2020-03-11T18:49:13Z"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/summary": {
"get": {
"tags": [
"Documents"
],
"summary": "List document summaries",
"description": "Queries your documents using the provided parameters.",
"operationId": "signature/ListDocumentSummaries",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "externalId",
"in": "query",
"description": "Documents external id",
"required": false,
"type": "string"
},
{
"name": "signerId",
"in": "query",
"description": "Signer Id",
"required": false,
"type": "string",
"format": "uuid"
},
{
"name": "externalSignerId",
"in": "query",
"description": "External signer Id",
"required": false,
"type": "string"
},
{
"name": "fromDate",
"in": "query",
"description": "Documents created from date (ticks)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "toDate",
"in": "query",
"description": "Documents created to date (ticks)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "lastUpdated",
"in": "query",
"description": "Documents updated after this date (ticks)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "signedDate",
"in": "query",
"description": "Documents signed after this date (ticks)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "nameOfSigner",
"in": "query",
"description": "Name of signer",
"required": false,
"type": "string"
},
{
"name": "title",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"description": "Document status",
"required": false,
"type": "string",
"enum": [
"unsigned",
"waiting_for_attachments",
"partialsigned",
"signed",
"canceled",
"expired"
]
},
{
"name": "tags",
"in": "query",
"description": "Document tags",
"required": false,
"type": "string"
},
{
"name": "offset",
"in": "query",
"description": "Used for paging (will be automatically set in response links)",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
{
"name": "limit",
"in": "query",
"description": "Set how many results you want per page (max/default 100)",
"required": false,
"type": "integer",
"format": "int32",
"default": 100
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CollectionWithPaging[DocumentSummary]"
},
"examples": {
"application/json": {
"offset": 0,
"limit": 2,
"size": 45,
"links": {
"next": "https://api.idfy.io/signature/documents/summary?limit=2&offset=2",
"first": "https://api.idfy.io/signature/documents/summary?limit=2"
},
"data": [
{
"documentId": "d92a74ab-2c61-4aca-a33f-b88341e68af5",
"accountId": "87b2d5e3-ca85-4867-bed1-4313b07910f9",
"title": "House contract",
"description": "Sample avenue 42",
"lastUpdated": "2020-03-11T18:49:13Z",
"deadline": "2020-03-17T05:49:13Z",
"status": {
"documentStatus": "partialsigned"
},
"externalId": "ipoqj9r8232j54rmno2i3lmfrå2q034frlk",
"documentSignatures": [
{
"signerId": "67917280-f789-4464-9268-c9fd6538f4a5",
"externalSignerId": "oiuhw2n97483hr3w9oiufn2wi3",
"signatureMethod": "no_bankid_netcentric",
"fullName": "Superhero, Awesome",
"firstName": "Awesome",
"lastName": "Superhero",
"signedTime": "2020-03-13T00:49:13Z",
"dateOfBirth": "1984-10-21",
"signatureMethodUniqueId": "",
"socialSecurityNumber": {
"value": "21108412345",
"countryCode": "NO"
},
"clientIp": "69.89.31.226",
"mechanism": "pkisignature",
"personalInfoOrigin": "unknown"
}
],
"requiredSignatures": 2,
"currentSignatures": 1,
"tags": [
"departement4"
],
"attachments": [
"6f14ae1b-1bfc-4c58-b73e-ef5ddc4178c4"
],
"signers": [
"67917280-f789-4464-9268-c9fd6538f4a5",
"0f0a9bd1-100a-40cb-8b43-50cd5b0de6f6"
],
"created": "2020-03-11T18:49:13Z"
},
{
"documentId": "ef69cea2-de86-41a4-82f8-65c87337a96e",
"accountId": "52bff45c-c608-472b-aa0e-73bccd18794d",
"title": "House contract",
"description": "Sample avenue 51",
"lastUpdated": "2020-03-11T18:49:13Z",
"deadline": "2020-03-17T05:49:13Z",
"status": {
"documentStatus": "unsigned"
},
"externalId": "9w87eht3984inf3wo0mf43p0owke",
"requiredSignatures": 2,
"currentSignatures": 0,
"tags": [
"departement4"
],
"signers": [
"de557a75-a2f5-49d1-93c4-254dadb38c20",
"167053c5-6d67-43fb-ace6-dbd5c2d28553"
],
"created": "2020-03-11T18:49:13Z"
}
]
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/files": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve file",
"description": "Retrieves the signed document file.",
"operationId": "signature/RetrieveFile",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"unsigned",
"native",
"standard_packaging",
"pades",
"xades"
]
},
{
"name": "originalFileName",
"in": "query",
"description": "Set this to true if you want us to name the file with the original filename",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/files/signers/{signerId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve file for signer",
"description": "Retrieves the signed document file for the specified signer.",
"operationId": "signature/RetrieveFileForSigner",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"description": "The signers Id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"native",
"packaged"
]
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/files/attachments/{attachmentId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve attachment file",
"description": "Retrieves the attachment file.",
"operationId": "signature/RetrieveAttachmentFile",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"unsigned",
"native",
"standard_packaging",
"pades",
"xades"
]
},
{
"name": "originalFileName",
"in": "query",
"description": "Set this to true if you want us to name the file with the original filename",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/files/attachments/{attachmentId}/signers/{signerId}": {
"get": {
"tags": [
"Files"
],
"summary": "Retrieve attachment for signer",
"description": "Retrieves the attachment file for the specified signer.",
"operationId": "signature/RetrieveAttachmentForSigner",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "attachmentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"description": "The signers Id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "fileFormat",
"in": "query",
"description": "",
"required": false,
"type": "string",
"enum": [
"native",
"packaged"
]
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/notifications": {
"get": {
"tags": [
"Notifications"
],
"summary": "List notifications",
"description": "Returns a list of all notifications that has been sent / attempted sent for a document",
"operationId": "signature/ListNotifications",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/NotificationLogItem"
}
},
"examples": {
"application/json": [
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample email",
"text": "email text",
"messageType": "EMAIL",
"status": "DELIVERED",
"receiver": "test@test.com"
},
{
"sentTimeStamp": "1/8/2018 10:58 AM",
"title": "Sample sms",
"text": "sms text",
"messageType": "SMS",
"status": "DELIVERED",
"receiver": "test@test.com"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/notifications/reminder": {
"post": {
"tags": [
"Notifications"
],
"summary": "Send reminders",
"description": "If you want to send out reminders to all/some of the signers manually you can do it here.",
"operationId": "signature/SendReminders",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "manualReminder",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/ManualReminder"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ManualReminder"
},
"examples": {
"application/json": {
"notificationSetting": "sendEmail",
"signers": {
"dcb95f88-7c22-48cf-b11c-28fe2fe6deb8": null,
"cc9bbacb-33b9-4110-a450-dcefc73e34ea": {
"emailOverride": "overrideemail@test.com"
}
}
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/signature-methods": {
"get": {
"tags": [
"SignatureMethods"
],
"summary": "List signature-methods",
"description": "Returns a list of all the supported signature-methods",
"operationId": "signature/ListSignature-Methods",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "mechanism",
"in": "query",
"description": "The result may vary with different signature mechanisms. Defaults to pkisignature",
"required": false,
"type": "string",
"enum": [
"pkisignature",
"identification",
"handwritten",
"handwritten_with_identification"
]
},
{
"name": "fileType",
"in": "query",
"description": "FileType that will be signed, some signature methods have different file support. Defaults to pdf",
"required": false,
"type": "string",
"enum": [
"pdf",
"txt",
"xml"
]
},
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to EN (english)",
"required": false,
"type": "string",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
]
},
{
"name": "signableAttachments",
"in": "query",
"description": "Signing multiple documents? Some signature-methods may lack this functionality",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": [
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID",
"description": "BankID with hardware token or other one time password",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "no_bankid_mobile",
"name": "Norwegian mobile BankID",
"description": "BankID on your mobile device",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "se_bankid",
"name": "Swedish BankID",
"description": "Using mobile BankID app or BankID security software on PC",
"logoUrl": "https://idfy-img.azureedge.net/openid/swedish_bankid_logo.svg"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/signature-methods/account": {
"get": {
"tags": [
"SignatureMethods"
],
"summary": "List signature-methods for account",
"description": "Returns a list of all the signature-methods available for the requester's account.",
"operationId": "signature/ListSignature-MethodsForAccount",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "mechanism",
"in": "query",
"description": "The result may vary with different signature mechanisms. Defaults to pkisignature",
"required": false,
"type": "string",
"enum": [
"pkisignature",
"identification",
"handwritten",
"handwritten_with_identification"
]
},
{
"name": "fileType",
"in": "query",
"description": "FileType that will be signed, some signature methods have different file support. Defaults to pdf",
"required": false,
"type": "string",
"enum": [
"pdf",
"txt",
"xml"
]
},
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to EN (english)",
"required": false,
"type": "string",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
]
},
{
"name": "signableAttachments",
"in": "query",
"description": "Signing multiple documents? Some signature-methods may lack this functionality",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": [
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID",
"description": "BankID with hardware token or other one time password",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "no_bankid_mobile",
"name": "Norwegian mobile BankID",
"description": "BankID on your mobile device",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "se_bankid",
"name": "Swedish BankID",
"description": "Using mobile BankID app or BankID security software on PC",
"logoUrl": "https://idfy-img.azureedge.net/openid/swedish_bankid_logo.svg"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/signers/{signerId}": {
"get": {
"tags": [
"Signers"
],
"summary": "Retrieve signer",
"description": "Retrieves the details of a single signer.",
"operationId": "signature/RetrieveSigner",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SignerResponse"
},
"examples": {
"application/json": {
"id": "f90791ac-14e5-45b9-9b75-f61655820afd",
"url": "https://sign-test.idfy.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"order": 0,
"required": false,
"signUrlExpires": "2020-03-16T05:49:13Z",
"getSocialSecurityNumber": false
}
}
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Signers"
],
"summary": "Delete signer",
"operationId": "signature/DeleteSigner",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Signers"
],
"summary": "Update signer",
"operationId": "signature/UpdateSigner",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateSignerRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/UpdateSignerResponse"
},
"examples": {
"application/json": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2020-03-15T05:49:13Z"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/signers": {
"get": {
"tags": [
"Signers"
],
"summary": "List signers",
"operationId": "signature/ListSigners",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignerResponse"
}
},
"examples": {
"application/json": [
{
"id": "f6f67ed8-8ab1-44b3-a24d-e314e5e4f338",
"url": "https://sign-test.idfy.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"order": 0,
"required": false,
"signUrlExpires": "2020-03-16T05:49:13Z",
"getSocialSecurityNumber": false
}
]
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Signers"
],
"summary": "Create signer",
"operationId": "signature/CreateSigner",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signer",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/SignerRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/SignerResponse"
},
"examples": {
"application/json": {
"id": "54ce2717-4202-4976-b3c0-0e6a158bcc51",
"url": "https://sign-test.idfy.io/init?jwt=...",
"externalSignerId": "aoijfnmo032q223",
"redirectSettings": {
"redirectMode": "redirect",
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"order": 0,
"required": false,
"signUrlExpires": "2020-03-16T05:49:13Z",
"getSocialSecurityNumber": false
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/documents/{documentId}/signers/{signerId}/signature": {
"delete": {
"tags": [
"Signers"
],
"summary": "Delete signature",
"operationId": "signature/DeleteSignature",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "documentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "signerId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/stats/count": {
"get": {
"tags": [
"Stats"
],
"summary": "Count",
"description": "How many documents has changed state / will be changing state within a time interval",
"operationId": "signature/Count",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "type",
"in": "query",
"description": "The type of stat counted",
"required": false,
"type": "string",
"enum": [
"document_created",
"document_signed",
"document_expiring",
"document_deleted"
]
},
{
"name": "fromDate",
"in": "query",
"description": "Defaults -24/0 hours diff from utc now (depends on type)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "toDate",
"in": "query",
"description": "Defaults 0/+24 hours diff from utc now (depends on type)",
"required": false,
"type": "string",
"format": "date-time"
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/stats/latest": {
"get": {
"tags": [
"Stats"
],
"summary": "Latest",
"description": "Get a ordered list of documents which have changed state/ will be changing state",
"operationId": "signature/Latest",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "type",
"in": "query",
"description": "The type of stat to list",
"required": false,
"type": "string",
"enum": [
"document_created",
"document_signed",
"document_expiring",
"document_deleted"
]
},
{
"name": "limit",
"in": "query",
"description": "How many documents to list (0-100), defaults to 10",
"required": false,
"type": "integer",
"format": "int32",
"default": 10
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/signature/themes/list/themes": {
"get": {
"tags": [
"Themes"
],
"summary": "List themes",
"description": "This endpoint lists all the color themes you can use in our sign application",
"operationId": "signature/ListThemes",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Theme"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/signature/themes/list/spinners": {
"get": {
"tags": [
"Themes"
],
"summary": "List spinners",
"description": "This endpoint lists all the spinners you can use in our sign application",
"operationId": "signature/ListSpinners",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Spinner"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/information/aml/b2c": {
"get": {
"tags": [
"Aml"
],
"summary": "B2C Identify and Screening Request",
"description": "Person screening with data enhancement enabled for nationalities where data enhancement is provided. For other nationalities the data enhancement will be skipped\r\n**Required fields**: Name with either birthDate or ssn.",
"operationId": "information/B2CIdentifyAndScreeningRequest",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Complete name of person. (Order of first and last names is not significant.)",
"required": true,
"type": "string"
},
{
"name": "ssn",
"in": "query",
"description": "National Identification number. SSN or Birthdate are REQUIRED (Se NationalId format)",
"required": false,
"type": "string"
},
{
"name": "birthDate",
"in": "query",
"description": "Date of birth. SSN or Birthdate are REQUIRED (format: yyyyMMdd)",
"required": false,
"type": "string"
},
{
"name": "nationality",
"in": "query",
"description": "Nationality of person (two letters ISO 3166 )",
"required": false,
"type": "string"
},
{
"name": "language",
"in": "query",
"description": "Language to use in response where applicable, optional. (two letters ISO 3166 )",
"required": false,
"type": "string"
},
{
"name": "includeReport",
"in": "query",
"description": "Create a PDF report with the data timestamp and sealed as future proof for the process.",
"required": false,
"type": "boolean"
},
{
"name": "mode",
"in": "query",
"description": "What mode to use. When using identify and screening data enhancement is enabled for nationalities where data enhancement is provided.",
"required": false,
"type": "string",
"enum": [
"screen",
"identify_and_screen"
]
}
],
"responses": {
"404": {
"description": "Not found"
},
"401": {
"description": "Not authorized"
},
"400": {
"description": "Bad request"
},
"500": {
"description": "Internal Server Error (Miscellaneous)"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PersonAmlResponse"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/aml/b2b": {
"get": {
"tags": [
"Aml"
],
"summary": "B2B Identify and Screening Request",
"description": "Person screening with data enhancement enabled for nationalities where data enhancement is provided. For other nationalities the data enhancement will be skipped\r\n**Required fields**: Name with either birthDate or ssn.",
"operationId": "information/B2BIdentifyAndScreeningRequest",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Complete name of person. (Order of first and last names is not significant.)",
"required": true,
"type": "string"
},
{
"name": "regNo",
"in": "query",
"description": "Business registration number",
"required": false,
"type": "string"
},
{
"name": "dunsNo",
"in": "query",
"description": "D-U-N-S number",
"required": false,
"type": "string"
},
{
"name": "nationality",
"in": "query",
"description": "Nationality of person (two letters ISO 3166 )",
"required": false,
"type": "string"
},
{
"name": "language",
"in": "query",
"description": "Language to use in response where applicable, optional. (two letters ISO 3166 )",
"required": false,
"type": "string"
},
{
"name": "includeReport",
"in": "query",
"description": "Create a PDF report with the data timestamp and sealed as future proof for the process.",
"required": false,
"type": "boolean"
},
{
"name": "mode",
"in": "query",
"description": "What mode to use. When using identify and screening data enhancement is enabled for nationalities where data enhancement is provided.",
"required": false,
"type": "string",
"enum": [
"screen",
"identify_and_screen"
]
}
],
"responses": {
"404": {
"description": "Not found"
},
"401": {
"description": "Not authorized"
},
"400": {
"description": "Bad request"
},
"500": {
"description": "Internal Server Error (Miscellaneous)"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompanyAmlResponse"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/business/info/difi": {
"get": {
"tags": [
"Business"
],
"summary": "Retrieve information from Difi",
"description": "Query company information from difi datahotell (official data from bronnoysund), supports query by name and/or orgnumber",
"operationId": "information/RetrieveInformationFromDifi",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orgnumber",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "companyname",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"404": {
"description": "Not found"
},
"400": {
"description": "Bad request"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DifiResponse"
}
},
"500": {
"description": "Internal Server Error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/business/info/matchit": {
"get": {
"tags": [
"Business"
],
"summary": "Retrieve information from Matchit",
"description": "Query company information from Matchit, Matchit uses existing information to build up their database. Supports query by name and/or orgnumber",
"operationId": "information/RetrieveInformationFromMatchit",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "companyname",
"in": "query",
"description": "query param",
"required": false,
"type": "string"
},
{
"name": "orgnumber",
"in": "query",
"description": "query param",
"required": false,
"type": "string"
}
],
"responses": {
"404": {
"description": "Not found"
},
"401": {
"description": "Not authorized"
},
"400": {
"description": "Bad request"
},
"500": {
"description": "Internal Server Error (Miscellaneous)"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CompanyInformationResponse"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/business/creditcheck": {
"get": {
"tags": [
"Business"
],
"summary": "Perform credit check",
"description": "Run a credit check on a specified company, this check will not produce any duplicate letters.\r\n A pdf report will be awailable to download the first 48 hours.",
"operationId": "information/PerformCreditCheck",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orgnumber",
"in": "query",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "userId",
"in": "query",
"description": "Override bisnode user Id",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "query",
"description": "Override bisnode password",
"required": false,
"type": "string"
},
{
"name": "countryCode",
"in": "query",
"description": "Default = \"NO\"",
"required": false,
"type": "string"
},
{
"name": "includeReport",
"in": "query",
"description": "Specify if you want a pdf report (defaults to false)",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreditCheckCompanyResponse"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/businessregistry": {
"get": {
"tags": [
"BusinessRegistry"
],
"summary": "List registration authorities",
"description": "Retrieves a list of business registration authorities globally",
"operationId": "information/ListRegistrationAuthorities",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/businessregistry/{authorityCode}": {
"get": {
"tags": [
"BusinessRegistry"
],
"summary": "Retrieve registration authority",
"description": "Retrieves detailed information about a specific registration authority",
"operationId": "information/RetrieveRegistrationAuthority",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "authorityCode",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/geodata/countries": {
"get": {
"tags": [
"GeoData"
],
"summary": "List countries",
"description": "Lists all countries in the world with English name and ISO 3166-1 country code",
"operationId": "information/ListCountries",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "lang",
"in": "query",
"description": "Language for result. Defaults to English",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/geodata/countries/{countryCode}": {
"get": {
"tags": [
"GeoData"
],
"summary": "Retrieve country info",
"description": "Retrieves basic geographical information about a country",
"operationId": "information/RetrieveCountryInfo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "path",
"description": "ISO 3166-1 country code to look up",
"required": true,
"type": "string"
},
{
"name": "lang",
"in": "query",
"description": "Language for result. Defaults to English",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/geodata/countries/{countryCode}/subdivisions": {
"get": {
"tags": [
"GeoData"
],
"summary": "List country subdivisions",
"description": "Retrieves a list over top level administrative subdivisions for a country with name and ISO 3166-2 region code",
"operationId": "information/ListCountrySubdivisions",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "countryCode",
"in": "path",
"description": "ISO 3166-1 country code to look up",
"required": true,
"type": "string"
},
{
"name": "lang",
"in": "query",
"description": "Language for result. Defaults to English",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/lei/{lei}/lookup": {
"get": {
"tags": [
"Lei"
],
"summary": "Retrieve LEI record",
"description": "Retrieve the entity record for a given LEI",
"operationId": "information/RetrieveLEIRecord",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "lei",
"in": "path",
"description": "LEI to retrieve",
"required": true,
"type": "string"
}
],
"responses": {
"404": {
"description": "Not found"
},
"401": {
"description": "Not authorized"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LeiRecord"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/lei/search": {
"get": {
"tags": [
"Lei"
],
"summary": "Query LEI records",
"description": "QueryLeiRecords for LEI-registered entities with filters",
"operationId": "information/QueryLEIRecords",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "countryCode",
"in": "query",
"description": "ISO 3166-1 alpha-2 country code for country entity is registered in",
"required": false,
"type": "string"
},
{
"name": "lei",
"in": "query",
"description": "LEI of entity",
"required": false,
"type": "string"
},
{
"name": "legalNameContains",
"in": "query",
"description": "Words included in entity's legal name",
"required": false,
"type": "string"
},
{
"name": "legalNameEquals",
"in": "query",
"description": "Exact phrase included in entity's legal name",
"required": false,
"type": "string"
},
{
"name": "registrationAuthorityEntityId",
"in": "query",
"description": "Entity Id provided by local business registry authority. For Norway this is the 'organisasjonsnummer' or tax identification number of the business",
"required": false,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"description": "Size of result set per request. Defaults to 25",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"description": "Current page number for result set. Defaults to 0",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"401": {
"description": "Not authorized"
},
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SearchResult"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/mobileinfo/authorize": {
"post": {
"tags": [
"MobileInfo"
],
"summary": "Mobile info",
"description": "With this enpoints a user can fill out a form with one click. Per now the user have to be a telenor customer to retrieve information from this endpoint.\r\n The url received here can be used in an iframe or a popupwindow, we will then deliever the user information with webmessageing.\r\n
\r\n Flow:
\r\n 1) Get url from this endpoint
\r\n 2) Open a popup window or an iframe with this url as src
\r\n 3) User authenticates and gives you permission to retrieve user information
\r\n 4) User is redirected to the callback endpoint, we connect to the serviceprovider API and retrieves the information about the user
\r\n 5) We use webmessaging so you can collect the information",
"operationId": "information/MobileInfo",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "serviceProvider",
"in": "query",
"description": "The name of the mobile service provider (telenor)",
"required": true,
"type": "string",
"enum": [
"telenor"
]
},
{
"name": "responseMode",
"in": "query",
"required": true,
"type": "string",
"enum": [
"popup",
"iframe"
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/person/creditcheck": {
"get": {
"tags": [
"Person"
],
"summary": "Run credit check",
"description": "Credit check of a single person. The use of this will produce a duplicate letter to the person that is checked.\r\n A pdf report will be awailable to download the first 48 hours.",
"operationId": "information/RunCreditCheck",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "socialSecurityNumber",
"in": "query",
"description": "",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "userId",
"in": "query",
"description": "Override bisnode user Id",
"required": false,
"type": "string"
},
{
"name": "password",
"in": "query",
"description": "Override bisnode password",
"required": false,
"type": "string"
},
{
"name": "phonenumber",
"in": "query",
"description": "Specify this to use electronic duplicate letters",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "email",
"in": "query",
"description": "Specify this to use electronic duplicate letters",
"required": false,
"type": "string"
},
{
"name": "includeReport",
"in": "query",
"description": "Specify if you want a pdf report (defaults to false)",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Person.CreditCheckPersonResponse"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/person/info/matchit": {
"get": {
"tags": [
"Person"
],
"summary": "Retrieve person info through MatchIt",
"description": "Returns (unofficial) person information, this method returns the best match from the query parameters served. The information is delievered by Matchit. \r\nValid query parameter combinations: name + dateOfBirth, name + socialSec, name + address, phonenumber",
"operationId": "information/RetrievePersonInfoThroughMatchit",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "socialSec",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "dateOfBirth",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "phonenumber",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "address",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Person.PersonInformation"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/person/info/matchit/query": {
"get": {
"tags": [
"Person"
],
"summary": "List person info through MatchIt by query",
"description": "Returns (unofficial) person information, this method returns the 5 best matches from the query parameters served (freetext). The information is delievered by Matchit.",
"operationId": "information/ListPersonInfoThroughMatchitByQuery",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "queryString",
"in": "query",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.PersonInformation"
}
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/person/info/infotorget": {
"get": {
"tags": [
"Person"
],
"summary": "Retrieve person info through Infotorget",
"description": "Run a query using social security number as parameter. The use of this requires username and password for Infortorget with the required permissions.\r\nValid query parameter combinations: \r\nsocialSecurityNumber, \r\nsocialSecurityNumber + firstName + lastName, \r\ndateOfBirth + firstName + lastName, \r\nfirstName + lastName + address + postalCode",
"operationId": "information/RetrievePersonInfoThroughInfotorget",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "username",
"in": "query",
"description": "Infotorget username",
"required": true,
"type": "string"
},
{
"name": "password",
"in": "query",
"description": "Infotorget password",
"required": true,
"type": "string"
},
{
"name": "reason",
"in": "query",
"description": "Reason for request",
"required": true,
"type": "string"
},
{
"name": "system",
"in": "query",
"description": "Your system name (Cannot contain any special characters or numbers)",
"required": true,
"type": "string"
},
{
"name": "socialSecurityNumber",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "firstname",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "lastname",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "dateofbirth",
"in": "query",
"description": "",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "address",
"in": "query",
"description": "",
"required": false,
"type": "string"
},
{
"name": "postalcode",
"in": "query",
"description": "",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Person.OfficialPersonRegistryResponse"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/report/{reportId}": {
"get": {
"tags": [
"Report"
],
"summary": "Retrive report",
"description": "The pdf report will be awailable to download the first 48 hours.",
"operationId": "information/RetriveReport",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The reportId returned from the Get",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "PDF file"
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
},
"404": {
"description": "Data not found"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/signroles/rights": {
"get": {
"tags": [
"SignatureRolesCheck"
],
"summary": "Get rights",
"description": "Check which person(s) that has the right to sign documents in an organization. You will receive lists with names and date of birth for the persons allowed for signing / prokura.",
"operationId": "information/GetRights",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "orgnumber",
"in": "query",
"description": "",
"required": true,
"type": "string"
},
{
"name": "countrycode",
"in": "query",
"description": "Default value is \"NO\"",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SignatureRights"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
},
"404": {
"description": "Organization data not found"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/information/signroles/signature/check": {
"post": {
"tags": [
"SignatureRolesCheck"
],
"summary": "Check signatures / prokura",
"description": "Check if received signatures and/or prokura are valid. This call allows you to do this check for multiple organizations simulataneously.\r\nA valid date of birth in this format [ddMMyy] is required. The persons last name plus minimum one other part of the signees name (first, (middle) and last name has to be separated by whitespace, comma or ;). \r\nA report that explains the validity of the signatures can be included.",
"operationId": "information/CheckSignatures/Prokura",
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "data",
"in": "body",
"description": "An array including all the organizations you want to check",
"required": true,
"schema": {
"$ref": "#/definitions/SignatureCheckRequest"
}
},
{
"name": "includereport",
"in": "query",
"description": "Returns a pdf report explaining the validity of the checked signatures, default value is true",
"required": false,
"type": "boolean"
},
{
"name": "countrycode",
"in": "query",
"description": "Default value is \"NO\"",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SignatureStatusResponse"
}
},
"400": {
"description": "Bad request"
},
"401": {
"description": "Not authorized"
},
"500": {
"description": "Internal server error (Miscellaneous)"
},
"404": {
"description": "Organization data not found"
}
},
"security": [
{
"oauth2": [
"addons"
]
}
],
"x-idfy-employeesonly": false
}
},
"/share/buckets/{id}/recipients/{recipientId}": {
"get": {
"tags": [
"Recipients"
],
"summary": "Retrieve recipient",
"description": "Retrieves a single recipient",
"operationId": "share/RetrieveRecipient",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
},
{
"name": "recipientId",
"in": "path",
"description": "The unique identifier for the recipient",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/RecipientResponse"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-03-29T08:00:55.8324522+00:00",
"mobile": {
"countryCode": "47",
"number": "123456789"
},
"content": [
{
"name": "testing.pdf",
"opened": true,
"openedDate": "2020-03-25T09:00:55.8324485+00:00"
}
],
"externalId": "external",
"url": "https://share.idfy.no/login?j=oeronyterny",
"oneTimeLogin": false
}
}
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Recipients"
],
"summary": "Delete recipient",
"description": "",
"operationId": "share/DeleteRecipient",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
},
{
"name": "recipientId",
"in": "path",
"description": "The unique identifier for recipient",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Recipients"
],
"summary": "Update recipient",
"description": "Updates specified recipient",
"operationId": "share/UpdateRecipient",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
},
{
"name": "recipientId",
"in": "path",
"description": "The unique identifier for the recipient",
"required": true,
"type": "string"
},
{
"name": "updatedRecipient",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateRecipent"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/RecipientResponse"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-03-29T08:00:55.849566+00:00",
"mobile": {
"countryCode": "47",
"number": "123456789"
},
"content": [
{
"name": "testing.pdf",
"opened": true,
"openedDate": "2020-03-25T09:00:55.8495643+00:00"
}
],
"externalId": "external",
"url": "https://share.idfy.no/login?j=oeronyterny",
"oneTimeLogin": false
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/share/buckets/{id}": {
"get": {
"tags": [
"Share"
],
"summary": "Retrieve secure bucket",
"description": "Retrieves details of a single secure bucket",
"operationId": "share/RetrieveSecureBucket",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure share",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareResponse"
},
"examples": {
"application/json": {
"id": "f9eaf3a4-de67-41a5-ae20-384683667693",
"information": {
"title": "Idfy.io shared a file with you",
"description": "Share created by Idfy.io",
"externalId": "external",
"departmentId": "d12409"
},
"recipients": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-04-03T08:00:55.8605884+00:00",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"content": [
{
"name": "testing1.pdf",
"opened": false,
"openedDate": "2020-03-26T09:00:55.8605878+00:00"
}
],
"externalId": "exernalt1234",
"url": "https://share.idfy.no/login?j=gonertnwet2135",
"oneTimeLogin": false
}
],
"content": [
{
"id": "1234",
"name": "testing1.pdf",
"content": "Text, path or something similar",
"type": 0
}
],
"uploadedDocuments": 2,
"created": "2020-03-27T09:00:55.8605827+00:00",
"done": false,
"deleted": false,
"contactDetails": {
"name": "idfy.io",
"phone": "12345678",
"email": "support@idfy.io",
"url": "https://idfy.io"
},
"senders": [
{
"email": "support@idfy.io",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"notificationType": 2,
"notificationEvent": 3
}
]
}
}
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Share"
],
"summary": "Delete secure bucket",
"description": "Deletes the specified secure bucket.",
"operationId": "share/DeleteSecureBucket",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Share"
],
"summary": "Update secure bucket",
"description": "",
"operationId": "share/UpdateSecureBucket",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateShareRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareResponse"
},
"examples": {
"application/json": {
"id": "1f66de3b-c624-4fea-aac4-fbd5d6f358bd",
"information": {
"title": "Idfy.io shared a file with you",
"description": "Share created by Idfy.io",
"externalId": "external",
"departmentId": "d12409"
},
"recipients": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-04-03T08:00:55.8724461+00:00",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"content": [
{
"name": "testing1.pdf",
"opened": false,
"openedDate": "2020-03-26T09:00:55.8724456+00:00"
}
],
"externalId": "exernalt1234",
"url": "https://share.idfy.no/login?j=gonertnwet2135",
"oneTimeLogin": false
}
],
"content": [
{
"id": "1234",
"name": "testing1.pdf",
"content": "Text, path or something similar",
"type": 0
}
],
"uploadedDocuments": 2,
"created": "2020-03-27T09:00:55.8724419+00:00",
"done": false,
"deleted": false,
"contactDetails": {
"name": "idfy.io",
"phone": "12345678",
"email": "support@idfy.io",
"url": "https://idfy.io"
},
"senders": [
{
"email": "support@idfy.io",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"notificationType": 2,
"notificationEvent": 3
}
]
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/share/buckets/{id}/recipients": {
"get": {
"tags": [
"Recipients"
],
"summary": "List recipients",
"description": "Retrieves a list of all recipients on bucket",
"operationId": "share/ListRecipients",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/RecipientResponse"
}
},
"examples": {
"application/json": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-03-29T08:00:55.8742189+00:00",
"mobile": {
"countryCode": "47",
"number": "123456789"
},
"content": [
{
"name": "testing.pdf",
"opened": true,
"openedDate": "2020-03-25T09:00:55.8742162+00:00"
}
],
"externalId": "external",
"url": "https://share.idfy.no/login?j=oeronyterny",
"oneTimeLogin": false
}
]
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Recipients"
],
"summary": "Create recipient",
"description": "Creates a new recipient",
"operationId": "share/CreateRecipient",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure bucket",
"required": true,
"type": "string"
},
{
"name": "newRecipient",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/Recipient"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/RecipientResponse"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-03-29T08:00:55.8797498+00:00",
"mobile": {
"countryCode": "47",
"number": "123456789"
},
"content": [
{
"name": "testing.pdf",
"opened": true,
"openedDate": "2020-03-25T09:00:55.8797483+00:00"
}
],
"externalId": "external",
"url": "https://share.idfy.no/login?j=oeronyterny",
"oneTimeLogin": false
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/share/buckets": {
"get": {
"tags": [
"Share"
],
"summary": "List secure buckets",
"description": "Returns a list of all your secure buckets",
"operationId": "share/ListSecureBuckets",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/ShareResponse"
}
},
"examples": {
"application/json": [
{
"id": "07228c09-0c7a-41b0-89d3-bb1b30a29c3c",
"information": {
"title": "Idfy.io shared a file with you",
"description": "Share created by Idfy.io",
"externalId": "external",
"departmentId": "d12409"
},
"recipients": [
{
"id": "00000000-0000-0000-0000-000000000000",
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-04-03T08:00:55.8822177+00:00",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"content": [
{
"name": "testing1.pdf",
"opened": false,
"openedDate": "2020-03-26T09:00:55.882217+00:00"
}
],
"externalId": "exernalt1234",
"url": "https://share.idfy.no/login?j=gonertnwet2135",
"oneTimeLogin": false
}
],
"content": [
{
"id": "1234",
"name": "testing1.pdf",
"content": "Text, path or something similar",
"type": 0
}
],
"uploadedDocuments": 2,
"created": "2020-03-27T09:00:55.8822151+00:00",
"done": false,
"deleted": false,
"contactDetails": {
"name": "idfy.io",
"phone": "12345678",
"email": "support@idfy.io",
"url": "https://idfy.io"
},
"senders": [
{
"email": "support@idfy.io",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"notificationType": 2,
"notificationEvent": 3
}
]
}
]
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Share"
],
"summary": "Create secure bucket",
"description": "Creates a new secure bucket. In the response you will receive an id to retrieve info about the share at a later time and upload content.",
"operationId": "share/CreateSecureBucket",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/CreateShareRequest"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/ShareResponse"
}
}
},
"x-idfy-employeesonly": false
}
},
"/share/buckets/{id}/upload/{contentId}": {
"post": {
"tags": [
"Share"
],
"summary": "Upload content",
"description": "Upload content to an existing bucket. The content will be deleted when the secure bucket expires. The content type has to be multipart/form-data;",
"operationId": "share/UploadContent",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier returned after the creation of the secure share",
"required": true,
"type": "string"
},
{
"name": "contentId",
"in": "path",
"description": "The unique identifier specified during creation for content",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/notification/events": {
"get": {
"tags": [
"Events"
],
"summary": "List unhandled events",
"description": "Retrieve up to 100 unhandled events for your account. After you retrieve this list the\r\n events will be \"locked\" for 10 minutes to give you time to handle them. Please handle the events using one of the endpoints in this API to avoid retrieving the same events multiple times.",
"operationId": "notification/Events_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "eventType",
"in": "query",
"description": "Filter by event type",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Filter the events by tags that was added to the document when you created it (comma-separated list)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/EventDto"
}
},
"examples": {
"application/json": [
{
"id": "735d876d-6500-4b0a-9812-f5daa8d90a09",
"type": "document_created",
"payload": {
"documentId": "da20cca6-d403-4e0a-a56c-367ef210850e",
"externalDocumentId": "8515000032"
},
"timestamp": "2018-06-12T11:21:17.6739072Z",
"accountId": "0379cc96-a22b-477d-b330-7aea3f0fbe4e"
},
{
"id": "724859fd-c716-4f36-9d8a-44103d3f366d",
"type": "document_created",
"payload": {
"documentId": "321355b5-eab4-441d-940c-489f04755d0f",
"externalDocumentId": "8515000033"
},
"timestamp": "2018-06-12T11:21:17.6739072Z",
"accountId": "feb86b05-8007-446b-943c-72e36a81f930"
}
]
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/{eventId}/handle": {
"post": {
"tags": [
"Events"
],
"summary": "Handle event",
"description": "Mark the status of an event as handled to make sure you dont retrieve this event again.",
"operationId": "notification/Events_Handle",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "eventId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/handle": {
"post": {
"tags": [
"Events"
],
"summary": "Handle multiple events",
"description": "Mark the status of a batch of events as handled to make sure you dont retrieve these events again.",
"operationId": "notification/Events_HandleMany",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [],
"parameters": [
{
"name": "eventIds",
"in": "body",
"description": "List of event IDs to handle.",
"required": true,
"schema": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
}
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/peek": {
"get": {
"tags": [
"Events"
],
"summary": "Peek events",
"description": "Peek top 100 unhandled events regardless if they are locked or not. Don't use this endpoint to handle events.",
"operationId": "notification/Events_Peek",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "eventType",
"in": "query",
"description": "Filter by event type",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"description": "Filter the events by tags that was added to the document when you created it (comma-separated list)",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/EventDto"
}
},
"examples": {
"application/json": [
{
"id": "b4d7718a-2e01-4f46-9cce-ef28c1ab9ccb",
"type": "document_created",
"payload": {
"documentId": "d396d22b-84d4-4c42-84d5-8e8490ce5741",
"externalDocumentId": "8515000032"
},
"timestamp": "2018-06-12T11:21:17.7975249Z",
"accountId": "a0645252-d740-47c0-9fc4-5352a2ce8b94"
},
{
"id": "68a42b2d-525f-4335-adf1-32b2c6e2f503",
"type": "document_created",
"payload": {
"documentId": "3ddaa8b9-8f0c-4e43-982a-d45d33ba3c55",
"externalDocumentId": "8515000033"
},
"timestamp": "2018-06-12T11:21:17.7975249Z",
"accountId": "6621bb82-2cdf-4c0c-9e58-648c4cd0442c"
}
]
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/clear": {
"post": {
"tags": [
"Events"
],
"summary": "Clear all events",
"description": "Clear all events for your account",
"operationId": "notification/Events_Clear",
"consumes": [],
"produces": [],
"responses": {
"200": {
"description": "OK"
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/types": {
"get": {
"tags": [
"Events"
],
"summary": "List event types",
"description": "Returns a list of all available event types.",
"operationId": "notification/Events_GetEventTypes",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/EventTypeInfo"
}
},
"examples": {
"application/json": [
{
"id": "document_created",
"name": "Document created",
"description": "When a new document is created."
},
{
"id": "document_signed",
"name": "Document signed",
"description": "When a document is signed by all required signers."
}
]
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/events/mock": {
"post": {
"tags": [
"Events"
],
"summary": "Mock event",
"description": "Creates a mock event with a sample payload. Can be used to test your event handling code.",
"operationId": "notification/Events_MockEvent",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MockEventRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/EventDto"
},
"examples": {
"application/json": {
"id": "1118f2fc-aa62-4dc8-9728-718ef56cec59",
"type": "document_created",
"payload": {
"documentId": "a2606600-cb44-4212-9d59-ddd16bbd49a2",
"externalDocumentId": "8515000032"
},
"timestamp": "2018-06-12T11:21:17.8600167Z",
"accountId": "f68900e5-15e3-4f9b-891c-5189d589f659",
"tags": [
"mock"
]
}
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/webhooks/{id}": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Retrieve webhook",
"description": "Retrieves the details of a single webhook.",
"operationId": "notification/Webhooks_GetSingleWebhook",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebhookDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "My webhook",
"active": true,
"events": [
"document_created",
"document_signed"
],
"config": {
"url": "https://example.com/webhook-endpoint",
"secret": "********",
"deliveryLogging": "failed"
},
"createdAt": "2018-06-12T10:21:17.8912614Z",
"updatedAt": "2018-06-12T11:21:17.8912614Z",
"lastResponse": {
"code": 200,
"message": "OK",
"timestamp": "2018-06-12T10:51:17.8912614+00:00"
}
}
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Webhooks"
],
"summary": "Delete webhook",
"description": "Deletes the specified webhook.",
"operationId": "notification/Webhooks_DeleteWebhook",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Webhooks"
],
"summary": "Update webhook",
"description": "Updates the specified webhook with the parameters passed.\r\nAny parameters not provided will be left unchanged.",
"operationId": "notification/Webhooks_UpdateWebhook",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "updatedWebhook",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/WebhookUpdateDto"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebhookDto"
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/webhooks": {
"get": {
"tags": [
"Webhooks"
],
"summary": "List webhooks",
"description": "Returns a list of all your webhooks.",
"operationId": "notification/Webhooks_ListWebhooks",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/WebhookDto"
}
},
"examples": {
"application/json": [
{
"id": 1,
"name": "My webhook",
"active": true,
"events": [
"document_created",
"document_signed"
],
"config": {
"url": "https://example.com/webhook-endpoint",
"secret": "********",
"deliveryLogging": "failed"
},
"createdAt": "2018-06-12T10:21:17.9068934Z",
"updatedAt": "2018-06-12T11:21:17.9068934Z",
"lastResponse": {
"code": 200,
"message": "OK",
"timestamp": "2018-06-12T10:51:17.9068934+00:00"
}
},
{
"id": 2,
"name": "Hook for all events",
"active": false,
"events": [
"*"
],
"config": {
"url": "https://example.com/another-webhook-endpoint",
"secret": "********",
"deliveryLogging": "never"
},
"createdAt": "2018-06-12T10:21:17.9068934Z",
"updatedAt": "2018-06-12T11:21:17.9068934Z",
"lastResponse": {
"code": 404,
"message": "Not Found",
"timestamp": "2018-06-12T10:51:17.9068934+00:00"
}
}
]
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Webhooks"
],
"summary": "Create webhook",
"description": "Creates a new webhook.",
"operationId": "notification/Webhooks_CreateWebhook",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "newWebhook",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/WebhookCreateDto"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/WebhookDto"
},
"examples": {
"application/json": {
"id": 1,
"name": "My webhook",
"active": true,
"events": [
"document_created",
"document_signed"
],
"config": {
"url": "https://example.com/webhook-endpoint",
"secret": "********",
"deliveryLogging": "failed"
},
"createdAt": "2018-06-12T10:21:18.0475202Z",
"updatedAt": "2018-06-12T11:21:18.0475202Z",
"lastResponse": {
"code": 200,
"message": "OK",
"timestamp": "2018-06-12T10:51:18.0475202+00:00"
}
}
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/webhooks/{id}/ping": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Ping webhook",
"description": "Triggers a ping event to be sent to the webhook.",
"operationId": "notification/Webhooks_PingWebhook",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/notification/webhooks/{id}/deliveries": {
"get": {
"tags": [
"Webhooks"
],
"summary": "List webhook deliveries",
"description": "Returns the 10 most recent delivery attempts for a single webhook.",
"operationId": "notification/Webhooks_GetWebhookDeliveries",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/WebhookDeliveryDto"
},
"examples": {
"application/json": {
"id": "2bcd3599-62c0-4860-9340-917e3242655b",
"webhookId": 14,
"eventId": "25c7d79f-f699-4a9c-8891-2528f8d4c57c",
"timestamp": "2018-06-12T11:21:18.0943891Z",
"url": "https://example.com/webhook-endpoint",
"elapsedMs": 190,
"requestHeaders": {
"Content-Type": "application/json",
"X-Idfy-Signature": "def564b8df06ae55c788493cb414068b2cf017385d96ecb39aa3e844fdbbcdea"
},
"requestBody": {
"id": "f3975a90-d88a-429e-b00c-4e6892041bae",
"type": "document_created",
"payload": {
"documentId": "5f46344c-e459-4b30-a2e8-520e3d107751",
"externalDocumentId": "8436324"
},
"timestamp": "2018-06-12T11:21:18.1100062Z",
"accountId": "4d8c9222-9356-42b0-9d09-0dc6bc5423c9",
"tags": null
},
"responseHeaders": {
"Cache-Control": "no-store, no-cache, max-age=0, private",
"Content-Length": "16"
},
"responseBody": {
"success": true
},
"responseStatusCode": 200,
"responseMessage": "OK"
}
}
}
},
"security": [
{
"oauth2": [
"event"
]
}
],
"x-idfy-employeesonly": false
}
},
"/deposit/personal/{id}": {
"get": {
"tags": [
"Personal"
],
"summary": "Retrieve deposit",
"description": "Retrieves the deposit with the given id",
"operationId": "deposit/RetrieveDeposit",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "queryPayment",
"in": "query",
"description": "Query the deposit for payment if possible, only valid for statuses: `SIGNED` or `PAID_PARTIAL`",
"required": false,
"type": "boolean",
"default": false
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDepositResponse"
},
"examples": {
"application/json": {
"id": "c9709978-5dbf-4c65-abea-fa130efc315b",
"documentId": "a4ba5698-7112-47ed-8b03-9cc196c6655b",
"tenants": [
{
"id": "d043480f-d365-41d5-a171-9c8c32da1044",
"url": "https://deposit.idfy.no/start",
"externalId": "24DE0123-6989-4FC0-9139-8577CF8D994F",
"aml": false,
"info": {
"firstName": "Kari",
"lastName": "Nordmann",
"mobile": {
"countryCode": "+47",
"number": "12345678"
},
"email": "kari.nordmann@idfy.io",
"nationality": "NO",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
}
},
"flow": "redirect",
"redirectSettings": {
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
}
}
],
"landlord": {
"name": "Ola Nordmann",
"organizationNumber": "998303168",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"nationality": "NO"
},
"created": "2020-03-26T12:47:45.2514379Z",
"contract": {
"depositAmount": 27000.0,
"paymentDeadline": "2020-04-05T11:47:45.251438+00:00"
},
"status": {
"depositStatus": "CREATED",
"funds": 0.0
},
"externalId": "B35D3A5F-0701-414C-84F0-37ECCA83A0D5",
"rentObject": {
"address": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"contactDetails": {
"email": "test@test.com"
}
}
}
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Personal"
],
"summary": "Update deposit",
"description": "Updates the deposit",
"operationId": "deposit/UpdateDeposit",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "model",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateDepositRequest"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDepositResponse"
}
}
},
"x-idfy-employeesonly": false
}
},
"/deposit/personal": {
"post": {
"tags": [
"Personal"
],
"summary": "Create deposit",
"description": "Create a new deposit",
"operationId": "deposit/CreateDeposit",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/CreateDepositRequest"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CreateDepositResponse"
},
"examples": {
"application/json": {
"id": "f812e7d2-e6ee-4685-85b4-fdb2ded31805",
"documentId": "2e0f69b5-7b37-4d4b-985a-452af2a4c7d7",
"tenants": [
{
"id": "fa19e269-efc8-49ce-8a4b-38965eba670f",
"url": "https://deposit.idfy.no/start",
"externalId": "24DE0123-6989-4FC0-9139-8577CF8D994F",
"aml": false,
"info": {
"firstName": "Kari",
"lastName": "Nordmann",
"mobile": {
"countryCode": "+47",
"number": "12345678"
},
"email": "kari.nordmann@idfy.io",
"nationality": "NO",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
}
},
"flow": "redirect",
"redirectSettings": {
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
}
}
],
"landlord": {
"name": "Ola Nordmann",
"organizationNumber": "998303168",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"nationality": "NO"
},
"created": "2020-03-26T12:47:45.2553931Z",
"contract": {
"depositAmount": 27000.0,
"paymentDeadline": "2020-04-05T11:47:45.2553932+00:00"
},
"status": {
"depositStatus": "CREATED",
"funds": 0.0
},
"externalId": "B35D3A5F-0701-414C-84F0-37ECCA83A0D5",
"rentObject": {
"address": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"contactDetails": {
"email": "test@test.com"
}
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/deposit/personal/{id}/cancel": {
"post": {
"tags": [
"Personal"
],
"summary": "Cancel deposit",
"description": "Cancel the deposit, funds that have been locked will be released to the tenant.",
"operationId": "deposit/CancelDeposit",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"202": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/deposit/personal/{id}/terminate": {
"post": {
"tags": [
"Personal"
],
"summary": "Release deposit",
"description": "Releases the deposit",
"operationId": "deposit/ReleaseDeposit",
"consumes": [
"application/json"
],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/TerminateRequest"
}
}
],
"responses": {
"200": {
"description": "used for `TENANT` category, deposit account has been released"
},
"202": {
"description": "used for `SPLIT` category, termination has been accepted for background processing"
}
},
"x-idfy-employeesonly": false
}
},
"/deposit/personal/summary": {
"get": {
"tags": [
"Personal"
],
"summary": "List deposit summaries",
"description": "Queries your deposits using the provided arguments",
"operationId": "deposit/ListDepositSummaries",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Optional, limit the results to those created from a date (ISO 8601)",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "status",
"in": "query",
"description": "Optional, limit the results to those with the provided status.",
"required": false,
"type": "string",
"enum": [
"CREATED",
"PAID",
"PAID_PARTIAL",
"TERMINATED",
"SIGNED"
]
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"default": 0
},
{
"name": "limit",
"in": "query",
"description": "Optional. Set how many results you want per page, max: 1000",
"required": false,
"type": "integer",
"format": "int32",
"default": 300
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/CollectionWithPaging[DepositSummary]"
},
"examples": {
"application/json": {
"size": 4,
"links": {
"next": "https://api.idfy.no/deposit/personal/summary?limit=2&offset=2",
"first": "https://api.idfy.no/deposit/personal/summary?limit=2"
},
"offset": 0,
"limit": 2,
"data": [
{
"id": "81bc7258-650e-4367-9a20-1d966f9c64a3",
"documentId": "b4abf84a-940f-493e-849f-fc5373fa89e2",
"status": {
"depositStatus": "PAID",
"funds": 27000.0
},
"createdDate": "2020-03-21T12:47:45.2584988Z",
"paymentDeadline": "2020-03-26T12:47:45.2584994Z",
"tenants": [
{
"firstName": "Kari",
"lastName": "Nordmann"
}
],
"landlord": {
"name": "Ola Nordmann"
}
},
{
"id": "a04e3be2-08e8-47d3-a029-64189f18ddaa",
"documentId": "aff9cc1c-3282-43f4-9800-d3c6da409cad",
"status": {
"depositStatus": "PAID_PARTIAL",
"funds": 21000.0
},
"createdDate": "2020-03-23T12:47:45.2585018Z",
"paymentDeadline": "2020-03-28T12:47:45.2585019Z",
"tenants": [
{
"firstName": "Tony",
"lastName": "Stark"
}
],
"landlord": {
"name": "Ola Nordmann"
}
}
]
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/admin/oauthclient/{clientId}": {
"get": {
"tags": [
"OAuthAPIClient"
],
"summary": "Retrieve OAuth client",
"description": "Returns the requested oauth client with settings. Requires the following scope: client_read",
"operationId": "admin/RetrieveOauthClient",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OauthAPIClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"OAuthAPIClient"
],
"summary": "Delete OAuth client",
"description": "Delete oauth API client. Requires the following scope: client_write",
"operationId": "admin/DeleteOauthClient",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/openid/{clientId}": {
"get": {
"tags": [
"OpenID"
],
"summary": "Retrieve OpenId client",
"description": "Returns the requested oauth client with settings. Requires the following scope: client_write",
"operationId": "admin/RetrieveOpenidClient",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OpenIdClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"OpenID"
],
"summary": "Delete OpenId client",
"description": "Requires the following scope: client_write",
"operationId": "admin/DeleteOpenidClient",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "clientId",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/{id}": {
"get": {
"tags": [
"Template"
],
"summary": "Retrieve template",
"description": "Gets a PDF template",
"operationId": "admin/RetrieveTemplate",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The template ID",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/PdfTemplate"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"put": {
"tags": [
"Template"
],
"summary": "Update template",
"description": "Updates the given PDF template",
"operationId": "admin/UpdateTemplate",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The template ID",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "model",
"in": "body",
"description": "The template body",
"required": false,
"schema": {
"$ref": "#/definitions/UpdatePdfTemplate"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/PdfTemplate"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Template"
],
"summary": "Delete template",
"description": "Deletes the PDF template",
"operationId": "admin/DeleteTemplate",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The template ID",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account": {
"get": {
"tags": [
"Account"
],
"summary": "Retrieve account",
"description": "Requires the following scope: account_read",
"operationId": "admin/RetrieveAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/Account"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"put": {
"tags": [
"Account"
],
"summary": "Update account",
"description": "Requires the following scope: account_write",
"operationId": "admin/UpdateAccount",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "accountDetails",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateAccountRequest"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/Account"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Account"
],
"summary": "Create account",
"description": "Requires dealer access. Contact support for assistance.",
"operationId": "admin/CreateAccount",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "accountDetails",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/CreateAccountRequest"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Account"
}
},
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account/list": {
"get": {
"tags": [
"Account"
],
"summary": "List accounts",
"description": "List accounts you have access to. Requires dealer access or the following scope: account_read",
"operationId": "admin/ListAccounts",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "orgNo",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "uniCustomerNo",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "createdBefore",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "createdAfter",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "lastModifiedBefore",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "lastModifiedAfter",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "dealerName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "dealerReference",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "tags",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "enabled",
"in": "query",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountListItem"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account/list/names": {
"get": {
"tags": [
"Account"
],
"summary": "List account names",
"description": "List names of accounts you have access to. Requires dealer access or the following scope: account_read",
"operationId": "admin/ListAccountNames",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountNameItem"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/admin/dealer/{dealerId}": {
"get": {
"tags": [
"Dealer"
],
"summary": "Retrieve dealer",
"description": "Requires dealer access. Contact support for assistance.",
"operationId": "admin/RetrieveDealer",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "dealerId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/Dealer"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Dealer"
],
"summary": "Update dealer",
"description": "Update dealer credentials. Requires dealer access. Contact support for assistance.",
"operationId": "admin/UpdateDealer",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "dealer",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/Dealer"
}
},
{
"name": "dealerId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/Dealer"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/dealer/{dealerId}/accounts": {
"get": {
"tags": [
"Dealer"
],
"summary": "List accounts for dealer",
"description": "Requires dealer access. Contact support for assistance.",
"operationId": "admin/ListAccountsForDealer",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "dealerId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AccountListItem"
}
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/invoice": {
"get": {
"tags": [
"Invoice"
],
"summary": "List account transactions",
"description": "Returns a list of transactions for the requested account. Requires on of the following scopes: [dealer, account-read, root]",
"operationId": "admin/ListAccountTransactions",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "year",
"in": "query",
"description": "Define a year",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "month",
"in": "query",
"description": "Define a month (0 - 12), not required",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "getAsCsv",
"in": "query",
"description": "If this is set to true a csv file is returned insted of transactionlist",
"required": true,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
},
"example": [
{
"ID": "5cde09af-23bb-445f-a291-dd27152e1207",
"Date": "2016-11-29T00:00:00",
"ProductID": "NO-BANKID-AUTH",
"Description": "Login for: Stark, Tony with: NO_BANKID_WEB External ref: 765a7ed2d95c4000b14d7a48eb267546",
"Count": 1,
"CustomerNumber": 10000,
"ExternalReference": "765a7ed2d95c4000b14d7a48eb267546",
"DepartmentId": "AssignmentNumber:11572"
},
{
"ID": "5cde09af-23bb-445f-a291-dd27152e2207",
"Date": "2016-11-29T00:00:00",
"ProductID": "NO-BANKID-SIGN",
"Description": "Login for: Stark, Tony with: NO_BANKID_WEB External ref: 44a2eb0f-6f7f-4e53-9cee-31594a5d6e40",
"Count": 2,
"CustomerNumber": 10000,
"ExternalReference": "44a2eb0f-6f7f-4e53-9cee-31594a5d6e40",
"DepartmentId": "AssignmentNumber:11573"
}
]
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/oauthclient/list": {
"get": {
"tags": [
"OAuthAPIClient"
],
"summary": "List OAuth clients",
"description": "Returns a list of all oauth clients registered on requested account. Requires the following scope: client_read",
"operationId": "admin/ListOauthClients",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthClientListItemResponse"
}
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/openid/list": {
"get": {
"tags": [
"OpenID"
],
"summary": "List OpenId clients for account",
"description": "Returns a list of all oauth clients registered on requested account. Requires the following scope: client_read",
"operationId": "admin/ListOpenidClientsForAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthClientListItemResponse"
}
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/defaults/details": {
"get": {
"tags": [
"Template"
],
"summary": "Retrieve default details template",
"description": "Gets the HTML used as a template for the details page if not overridden by user",
"operationId": "admin/RetrieveDefaultDetailsTemplate",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "language",
"in": "query",
"description": "Language of the details page",
"required": true,
"type": "string",
"enum": [
"en",
"no",
"sv",
"da",
"fi"
]
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/defaults/coverpage": {
"get": {
"tags": [
"Template"
],
"summary": "Retrieve default coverpage template",
"description": "Gets the HTML used as a template for the details page if not overridden by user",
"operationId": "admin/RetrieveDefaultCoverpageTemplate",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/PdfTemplate"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template": {
"get": {
"tags": [
"Template"
],
"summary": "List templates for account",
"description": "Lists all the PDF template for the account",
"operationId": "admin/ListTemplatesForAccount",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/PdfTemplateListItem"
}
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Template"
],
"summary": "Create template",
"description": "Creates a new PDF template",
"operationId": "admin/CreateTemplate",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"description": "Create PDF template body",
"required": false,
"schema": {
"$ref": "#/definitions/CreatePdfTemplate"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PdfTemplate"
}
},
"201": {
"description": "Created"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/timezones": {
"get": {
"tags": [
"Template"
],
"summary": "Retrieve Timezone list",
"description": "Lists all valid time zone",
"operationId": "admin/RetrieveTimezoneList",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account/logo": {
"post": {
"tags": [
"Account"
],
"summary": "Update account logo",
"description": "Upload / Update and resize account logo. Returns a url with your uploaded / resized logo. Requires the following scope: account_write",
"operationId": "admin/UpdateAccountLogo",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "accountLogo",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/AccountLogo"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account/styling": {
"post": {
"tags": [
"Account"
],
"summary": "Update account styling",
"description": "Upload / Update custom account css. Returns a url with your uploaded css. Requires the following scope: account_write",
"operationId": "admin/UpdateAccountStyling",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "styling",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/adminStyling"
}
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/account/disable": {
"post": {
"tags": [
"Account"
],
"summary": "Disable account",
"description": "Set the account as inactive / disabled. Requires the following scope: account_write",
"operationId": "admin/DisableAccount",
"consumes": [],
"produces": [],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/dealer/logo/{dealerId}": {
"post": {
"tags": [
"Dealer"
],
"summary": "Update dealer logo",
"description": "Set dealer Logo. Requires dealer access. Contact support for assistance.",
"operationId": "admin/UpdateDealerLogo",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "dealerLogo",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/DealerLogo"
}
},
{
"name": "dealerId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/oauthclient": {
"put": {
"tags": [
"OAuthAPIClient"
],
"summary": "Update OAuth client",
"description": "Updates the requested oauth client on the requested account. Requires the following scope: client_write",
"operationId": "admin/UpdateOauthClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "apiClient",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateOauthAPIClientRequest"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OauthAPIClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"OAuthAPIClient"
],
"summary": "Create OAuth client",
"description": "Create a new oauth api client for the requested account. Requires the following scope: client_write",
"operationId": "admin/CreateOauthClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "apiClient",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/CreateOauthAPIClientRequest"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OauthAPIClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/openid": {
"put": {
"tags": [
"OpenID"
],
"summary": "Update OpenId client",
"description": "Updates the requested openid client on the requested account. Requires the following scope: client_write",
"operationId": "admin/UpdateOpenidClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "client",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/UpdateOpenIdClientRequest"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OpenIdClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"OpenID"
],
"summary": "Create OpenId client",
"description": "Create a new openId client for the requested account. Requires the following scope: client_write",
"operationId": "admin/CreateOpenidClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "client",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/CreateOpenIdClientRequest"
}
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/OpenIdClientResponse"
}
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/preview/{id}": {
"post": {
"tags": [
"Template"
],
"summary": "Preview template from id",
"description": "Preview your PAdES template use your own signature file or choose the xmlTemplate prefilled",
"operationId": "admin/PreviewTemplateFromId",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"description": "Preview model",
"required": false,
"schema": {
"$ref": "#/definitions/TemplateWithIdPreview"
}
},
{
"name": "id",
"in": "path",
"description": "Template Id",
"required": true,
"type": "string",
"format": "uuid"
},
{
"name": "xmlTemplate",
"in": "query",
"required": false,
"type": "string",
"enum": [
"SINGEL_BANKID_NO",
"SINGEL_BANKID_SV",
"SINGEL_NEMID",
"MULTI_3_SIGNERS"
]
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Stream"
}
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/preview": {
"post": {
"tags": [
"Template"
],
"summary": "Preview template from model",
"description": "Preview your PAdES template use your own signature file or choose the xmlTemplate prefilled",
"operationId": "admin/PreviewTemplateFromModel",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "model",
"in": "body",
"description": "Preview model",
"required": false,
"schema": {
"$ref": "#/definitions/TemplatePreview"
}
},
{
"name": "xmlTemplate",
"in": "query",
"required": false,
"type": "string",
"enum": [
"SINGEL_BANKID_NO",
"SINGEL_BANKID_SV",
"SINGEL_NEMID",
"MULTI_3_SIGNERS"
]
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Stream"
}
}
},
"x-idfy-employeesonly": false
}
},
"/admin/template/datasource": {
"post": {
"tags": [
"Template"
],
"summary": "Retrieve data source",
"description": "Preview the underlaying template datasource",
"operationId": "admin/RetrieveDataSource",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "model",
"in": "body",
"description": "Preview model",
"required": false,
"schema": {
"$ref": "#/definitions/TemplatePreview"
}
},
{
"name": "xmlTempalte",
"in": "query",
"description": "Prefilled XmlSignature templates",
"required": false,
"type": "string",
"enum": [
"SINGEL_BANKID_NO",
"SINGEL_BANKID_SV",
"SINGEL_NEMID",
"MULTI_3_SIGNERS"
]
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/oauthclient/enable": {
"put": {
"tags": [
"OAuthAPIClient"
],
"summary": "Enable OAuth client",
"description": "Activates the requested oauth client. Requires the following scope: client_write",
"operationId": "admin/EnableOauthClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/OauthClientId"
}
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/oauthclient/disable": {
"put": {
"tags": [
"OAuthAPIClient"
],
"summary": "Disable OAuth client",
"description": "Deactivates the requested oauth client. Requires the following scope: client_write",
"operationId": "admin/DisableOauthClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/OauthClientId"
}
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/openid/enable": {
"put": {
"tags": [
"OpenID"
],
"summary": "Enable OpenId client",
"description": "Requires the following scope: client_write",
"operationId": "admin/EnableOpenidClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/OauthClientId"
}
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/admin/openid/disable": {
"put": {
"tags": [
"OpenID"
],
"summary": "Disable OpenId client",
"description": "Deactivates the requested oauth client. Requires the following scope: client_write",
"operationId": "admin/DisableOpenidClient",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/OauthClientId"
}
}
],
"responses": {
"200": {
"description": "Ok"
},
"400": {
"description": "Bad request"
},
"403": {
"description": "Forbidden (Access denied)"
},
"500": {
"description": "Internal server error"
}
},
"x-idfy-employeesonly": false
}
},
"/jwt/validate": {
"post": {
"tags": [
"Jwt"
],
"summary": "Validate JWT",
"operationId": "jwt/ValidatePost",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/ValidateJwtDto"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/JwtValidationResultDto"
}
}
},
"x-idfy-employeesonly": false
}
},
"/text/language-sets/{id}": {
"get": {
"tags": [
"Language Sets"
],
"summary": "Retrieve language set",
"description": "Retrieves the details of a single language set.",
"operationId": "text/RetrieveLanguageSet",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/LanguageSetDTO"
}
}
},
"x-idfy-employeesonly": false
},
"delete": {
"tags": [
"Language Sets"
],
"summary": "Delete language set",
"description": "Deletes the specified language set.",
"operationId": "text/DeleteLanguageSet",
"consumes": [],
"produces": [],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"204": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Language Sets"
],
"summary": "Update language set",
"description": "Updates the specified language set with the parameters passed.",
"operationId": "text/UpdateLanguageSet",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageSetUpdate",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/LanguageSetUpdateDTO"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/LanguageSetDTO"
}
}
},
"x-idfy-employeesonly": false
}
},
"/text/languages/{id}": {
"get": {
"tags": [
"Languages"
],
"summary": "Retrieve language",
"operationId": "text/RetrieveLanguage",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/LanguageDTO"
}
}
},
"x-idfy-employeesonly": false
}
},
"/text/languages": {
"get": {
"tags": [
"Languages"
],
"summary": "List all languages",
"description": "Returns a list of all supported languages.",
"operationId": "text/ListAllLanguages",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/LanguageDTO"
}
}
},
"x-idfy-employeesonly": false
}
},
"/text/language-sets": {
"get": {
"tags": [
"Language Sets"
],
"summary": "List language sets",
"description": "Returns a list of all your language sets.",
"operationId": "text/ListLanguageSets",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/LanguageSetDTO"
}
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Language Sets"
],
"summary": "Create language set",
"description": "Creates a new language set.",
"operationId": "text/CreateLanguageSet",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "newLanguageSet",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/LanguageSetCreateDTO"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/LanguageSetDTO"
}
}
},
"x-idfy-employeesonly": false
}
},
"/text/language-sets/{languageSetId}/translations/{subjectId}/{languageCode}": {
"get": {
"tags": [
"Translations"
],
"summary": "Retrieve translation",
"description": "Retrieves the details of a single translation.",
"operationId": "text/RetrieveTranslation",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "languageSetId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "subjectId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "path",
"description": "",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/TranslationDTO"
}
}
},
"x-idfy-employeesonly": false
},
"patch": {
"tags": [
"Translations"
],
"summary": "Update translation",
"description": "Updates the specified translation with the parameters passed.",
"operationId": "text/UpdateTranslation",
"consumes": [
"application/json-patch+json",
"application/json",
"text/json",
"application/*+json"
],
"produces": [],
"parameters": [
{
"name": "languageSetId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "subjectId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "languageCode",
"in": "path",
"description": "",
"required": true,
"type": "string"
},
{
"name": "translationUpdate",
"in": "body",
"description": "",
"required": false,
"schema": {
"$ref": "#/definitions/TranslationUpdateDTO"
}
}
],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/text/language-sets/{languageSetId}/translations": {
"get": {
"tags": [
"Translations"
],
"summary": "List translations",
"description": "Returns a list of all your translations for the given language set.",
"operationId": "text/ListTranslations",
"consumes": [],
"produces": [
"text/plain",
"application/json",
"text/json"
],
"parameters": [
{
"name": "languageSetId",
"in": "path",
"description": "",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "language",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "translationKeyGroupId",
"in": "query",
"required": true,
"type": "integer",
"format": "int32"
},
{
"name": "format",
"in": "query",
"required": false,
"type": "string",
"enum": [
"Normal",
"Minimal"
]
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TranslationDTO"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/validation/no/bankid/validate": {
"post": {
"tags": [
"Idfy.Validation Norwegian BankID"
],
"summary": "Validate SDO",
"description": "This service validates the signatures on the SDOdata, to validate the SDO we use the validation component from BankID Norway. \r\nIn this endpoint you can also include the data from the original document to validate that they matches the SDO data, the same goes for the signatures. (Ssn is only available if you have an account and validate-ssn scope)",
"operationId": "validation/NoBankIDValidation_ValidateSDO",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/ValidateSDORequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ValidateSDOResponse"
},
"examples": {
"application/json": {
"valid": true,
"seal": {
"sealedBy": "Idfy Norge AS",
"sealedTimestamp": "2018-02-09T10:17:25.9565528+00:00",
"certificate": {
"issuerName": "CN=BankID Bankenes ID-tjeneste Bank CA 2,OU=988477052,O=Bankenes ID-tjeneste AS,C=NO",
"subjectName": "CN=Testin\\C3\\A5g\\, Test,O=BankID - Bankenes ID-tjeneste,C=NO,serialNumber=9238-1234-4-1665443",
"validFromDate": "2016-03-28T19:10:24",
"validToDate": "2018-03-28T19:10:24",
"versionNumber": "3",
"serialNumber": "4660808",
"keyAlgorithm": "RSA",
"keySize": "2048",
"uniqueId": "2352-1453-1-1634543",
"originator": "3625",
"bankName": "Sparebanken Vest",
"dateOfBirth": "1987-12-01T00:00:00",
"policyOid": "2.16.578.1.16.1.12.1.1",
"commonName": "Testesen, Test",
"signingCertficate": "MIIFkTCCA3mgAwIBAAEWFAEDSFgIDRx5IMA0GCSqGSIsdfwetwefrsaBAYTAptHOvOFsnrVRVC09bBzw",
"x509Certificate": {
"rawData": "worsgnh4w9oj430OÅIUNEAFOIUEANOdhgfIUHBIUYngfw9oersnmsdmpoålaewdrq=="
},
"keyUsage": "signing",
"signingTime": "2017-02-06T08:23:18",
"phoneNumber": "",
"certificateType": "NETCENTRIC_QUALIFIED_PERSONAL_CERTIFICATE"
},
"sealValid": true
},
"signers": [
{
"identificator": "12345678911",
"identificatorType": "SSN",
"valid": true,
"name": "Musk, Elon"
}
],
"summary": "Summary text of the validation",
"validationError": {},
"auditId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/validation/no/bankid/parse": {
"post": {
"tags": [
"Idfy.Validation Norwegian BankID"
],
"summary": "Parse and validate sdo",
"description": "This service validates and parses the signatures on the SDOdata, to validate/parse the SDO we use the validation component from bankID norway. \r\nThis endpoint parses the SDO to readable data and provides you with information about the signatures and document.",
"operationId": "validation/NoBankIDValidation_ParseSDO",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/ParseSDORequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ParseSDOResponse"
},
"examples": {
"application/json": {
"auditId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"signersValid": true,
"seal": {
"sealedBy": "Idfy Norge AS",
"sealedTimestamp": "2018-02-09T10:17:26.1128031+00:00",
"certificate": {
"issuerName": "CN=BankID Bankenes ID-tjeneste Bank CA 2,OU=988477052,O=Bankenes ID-tjeneste AS,C=NO",
"subjectName": "CN=Testin\\C3\\A5g\\, Test,O=BankID - Bankenes ID-tjeneste,C=NO,serialNumber=9238-1234-4-1665443",
"validFromDate": "2016-03-28T19:10:24",
"validToDate": "2018-03-28T19:10:24",
"versionNumber": "3",
"serialNumber": "4660808",
"keyAlgorithm": "RSA",
"keySize": "2048",
"uniqueId": "2352-1453-1-1634543",
"originator": "3625",
"bankName": "Sparebanken Vest",
"dateOfBirth": "1987-12-01T00:00:00",
"policyOid": "2.16.578.1.16.1.12.1.1",
"commonName": "Idfy Norge AS",
"signingCertficate": "MIIFkTCCA3mgAwIBAAEWFAEDSFgIDRx5IMA0GCSqGSIsdfwetwefrsaBAYTAptHOvOFsnrVRVC09bBzw",
"x509Certificate": {
"rawData": "worsgnh4w9oj430OÅIUNEAFOIUEANOdhgfIUHBIUYngfw9oersnmsdmpoålaewdrq=="
},
"keyUsage": "signing",
"signingTime": "2017-02-06T08:23:18",
"phoneNumber": "",
"certificateType": "NETCENTRIC_QUALIFIED_PERSONAL_CERTIFICATE"
},
"sealValid": true
},
"signers": [
{
"certificate": {
"issuerName": "CN=BankID Bankenes ID-tjeneste Bank CA 2,OU=988477052,O=Bankenes ID-tjeneste AS,C=NO",
"subjectName": "CN=Testin\\C3\\A5g\\, Test,O=BankID - Bankenes ID-tjeneste,C=NO,serialNumber=9238-1234-4-1665443",
"validFromDate": "2016-03-28T19:10:24",
"validToDate": "2018-03-28T19:10:24",
"versionNumber": "3",
"serialNumber": "4660808",
"keyAlgorithm": "RSA",
"keySize": "2048",
"uniqueId": "2352-1453-1-1634543",
"originator": "3625",
"bankName": "Sparebanken Vest",
"dateOfBirth": "1987-12-01T00:00:00",
"policyOid": "2.16.578.1.16.1.12.1.1",
"commonName": "Testesen, Test",
"signingCertficate": "MIIFkTCCA3mgAwIBAAEWFAEDSFgIDRx5IMA0GCSqGSIsdfwetwefrsaBAYTAptHOvOFsnrVRVC09bBzw",
"x509Certificate": {
"rawData": "worsgnh4w9oj430OÅIUNEAFOIUEANOdhgfIUHBIUYngfw9oersnmsdmpoålaewdrq=="
},
"keyUsage": "signing",
"signingTime": "2017-02-06T08:23:18",
"phoneNumber": "",
"certificateType": "NETCENTRIC_QUALIFIED_PERSONAL_CERTIFICATE"
},
"name": "Testesen, Test",
"dateOfBirth": "1987-12-01T00:00:00",
"pid": "2352-1453-1-1634543",
"ssn": "12345678911",
"signedTimestamp": "2017-02-06T08:23:18",
"valid": true,
"ocsp": "IUNBAUJNDSA23425IYBDSAFIUYBI...",
"environment": "production"
}
],
"summary": "Validating summary",
"validationError": {},
"signedData": "P1RoaXMgdGV4dCBjYW4gYmUgc2lnbmVk"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/merchant/signature": {
"post": {
"tags": [
"Signature"
],
"summary": "Create merchant signature",
"operationId": "merchant/Signature_Sign",
"consumes": [
"application/json",
"text/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "request",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/merchantSignRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SignResponse"
},
"examples": {
"application/json": {
"signedData": "Base 64 encoded signed data",
"auditLogReference": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"signingFormat": "no_bankid_seid_sdo",
"signCertificateBase64String": "Base 64 encoded certificate used to sign data",
"transactionId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
}
}
},
"security": [
{
"oauth2": [
"merchantsign"
]
}
],
"x-idfy-employeesonly": false
}
},
"/merchant/signature/{transactionId}": {
"get": {
"tags": [
"Signature"
],
"summary": "Retrieve transaction",
"description": "Retrieves a single transaction.",
"operationId": "merchant/Signature_Get",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "transactionId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/MerchantSignTransaction"
},
"examples": {
"application/json": {
"id": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"accountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"auditLogReference": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"externalReference": "Some external reference",
"oauthClientId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"ipAddress": "192.168.0.1",
"xslt": "Hashed xslt (if exists, sha256)",
"dataToSign": "Hashed result (sha256)",
"result": "Hashed result (sha256)",
"certificate": "Base 64 encoded certificate used to sign data",
"timeStamp": "2016-05-02T12:34:42+00:00"
}
}
}
},
"security": [
{
"oauth2": [
"merchantsign"
]
}
],
"x-idfy-employeesonly": false
}
},
"/merchant/signature/list": {
"get": {
"tags": [
"Signature"
],
"summary": "List transactions",
"description": "Returns a list of transactions.",
"operationId": "merchant/Signature_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "oauthClientId",
"in": "query",
"description": "",
"required": true,
"type": "string"
},
{
"name": "fromDate",
"in": "query",
"description": "Date in ticks",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "toDate",
"in": "query",
"description": "Date in ticks",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/MerchantSignTransaction"
}
},
"examples": {
"application/json": [
{
"id": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"accountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"auditLogReference": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"externalReference": "Some external reference",
"oauthClientId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"ipAddress": "192.168.0.1",
"xslt": "Hashed xslt (if exists, sha256)",
"dataToSign": "Hashed result (sha256)",
"result": "Hashed result (sha256)",
"certificate": "Base 64 encoded certificate used to sign data",
"timeStamp": "2016-05-02T12:34:42+00:00"
},
{
"id": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"accountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"auditLogReference": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"externalReference": "Some external reference",
"oauthClientId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"ipAddress": "192.168.0.1",
"xslt": "Hashed xslt (if exists, sha256)",
"dataToSign": "Hashed result (sha256)",
"result": "Hashed result (sha256)",
"certificate": "Base 64 encoded certificate used to sign data",
"timeStamp": "2016-05-01T12:34:42+00:00"
}
]
}
}
},
"security": [
{
"oauth2": [
"merchantsign"
]
}
],
"x-idfy-employeesonly": false
}
},
"/merchant/signature/pades/{signedDocumentId}": {
"get": {
"tags": [
"Signature"
],
"summary": "Retrieve pades",
"description": "Retrieve pades of signed pdf file. This endpoint will only work on the api.idfy.no endpoint",
"operationId": "merchant/Signature_RetrievePades",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"name": "signedDocumentId",
"in": "path",
"description": "",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object"
}
}
},
"security": [
{
"oauth2": [
"merchantsign"
]
}
],
"x-idfy-employeesonly": false
}
},
"/config/status": {
"get": {
"tags": [
"Idfy Settings Status"
],
"summary": "Returns 200 OK",
"operationId": "config/Returns200OK",
"consumes": [],
"produces": [],
"responses": {
"200": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/id-providers": {
"get": {
"tags": [
"ID Providers"
],
"summary": "List ID providers",
"description": "Returns a list of all the supported ID providers.",
"operationId": "identification/v2/ListIDProviders",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to `en` (english).",
"required": false,
"type": "string",
"enum": [
"en",
"no",
"none"
]
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdProvider"
}
},
"examples": {
"application/json": [
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID",
"description": "With hardware token",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID on mobile",
"description": "BankID on your mobile device",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/id-providers/account": {
"get": {
"tags": [
"ID Providers"
],
"summary": "List ID providers for account",
"description": "Returns a list of all the ID providers available for the requester's account.",
"operationId": "identification/v2/ListIDProvidersForAccount",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "language",
"in": "query",
"description": "The language to use for name and description. Defaults to `en` (english).",
"required": false,
"type": "string",
"enum": [
"en",
"no",
"none"
]
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdProvider"
}
},
"examples": {
"application/json": [
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID",
"description": "With hardware token",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
},
{
"type": "no_bankid_netcentric",
"name": "Norwegian BankID on mobile",
"description": "BankID on your mobile device",
"logoUrl": "https://idfy-img.azureedge.net/openid/no_bankid_rgb_blue.svg"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/languages": {
"get": {
"tags": [
"Idfy Identification v2 Languages"
],
"summary": "List languages",
"description": "Returns a list of supported languages.",
"operationId": "identification/v2/ListLanguages",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Success",
"schema": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/LanguageDetails"
}
},
"examples": {
"application/json": [
{
"id": "en",
"name": "English"
},
{
"id": "no",
"name": "Norwegian"
}
]
}
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/sessions/{id}": {
"get": {
"tags": [
"Sessions"
],
"summary": "Retrieve session",
"description": "Retrieves the details of a single identification session.",
"operationId": "identification/v2/RetrieveSession",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The session's unique identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/IdSession"
},
"examples": {
"application/json": {
"id": "02fda05f53714070a452aa3a0107a913",
"url": "https://id.idfy.io?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"status": "success",
"created": "2020-03-19T11:16:53Z",
"expires": "2020-03-19T11:26:53Z",
"provider": "no_bankid_mobile",
"identity": {
"providerId": "9578-6000-4-48855",
"fullName": "John Doe",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "2000-03-19",
"nin": "01018012345"
},
"environment": {
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"ipAddress": "127.0.0.1"
},
"allowedProviders": [
"no_bankid_mobile",
"no_bankid_netcentric"
],
"language": "en",
"flow": "redirect",
"include": [
"name",
"date_of_birth",
"nin"
],
"redirectSettings": {
"successUrl": "https://example.com/success",
"abortUrl": "https://example.com/abort",
"errorUrl": "https://example.com/error"
},
"externalReference": "123456789"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/sessions": {
"get": {
"tags": [
"Sessions"
],
"summary": "List sessions",
"description": "Returns a list of previously created sessions. The session data returned from this endpoint does not contain any personal information.",
"operationId": "identification/v2/ListSessions",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "cursor",
"in": "query",
"description": "The cursor to send to the endpoint to receive the next batch of responses.",
"required": false,
"type": "string",
"maxLength": 100
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of items to return. Defaults to `25`.",
"required": false,
"type": "integer",
"format": "int32",
"maximum": 100.0,
"minimum": 1.0
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/PaginatedDataDto`1"
},
"examples": {
"application/json": {
"limit": 25,
"nextCursor": "c2Vzc2lvbl9pZA==",
"data": [
{
"id": "02fda05f53714070a452aa3a0107a913",
"url": "https://id.idfy.io?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"status": "success",
"created": "2020-03-19T11:16:53Z",
"expires": "2020-03-19T11:26:53Z",
"provider": "no_bankid_mobile",
"environment": {
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
},
"language": "en",
"flow": "redirect",
"externalReference": "123456789"
},
{
"id": "2836257c029749368f35aa3e007ab3c1",
"url": "https://id.idfy.io?jwt=eyJzdWIiOiIwOTg3NjU0MzIxIiwibmFtZSI6IkphbmUgRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.8j3Usx790vdlWJV27S6wgD6c4I6DE5R0haGHx8ZGrdY",
"status": "success",
"created": "2020-03-19T11:16:53Z",
"expires": "2020-03-19T11:26:53Z",
"provider": "no_bankid_netcentric",
"environment": {
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
},
"language": "en",
"flow": "iframe",
"externalReference": "123456789"
}
]
}
}
}
},
"x-idfy-employeesonly": false
},
"post": {
"tags": [
"Sessions"
],
"summary": "Create session",
"description": "Creates a new identification session.",
"operationId": "identification/v2/CreateSession",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "sessionCreateDto",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/IdSessionCreate"
}
}
],
"responses": {
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/IdSession"
},
"examples": {
"application/json": {
"id": "02fda05f53714070a452aa3a0107a913",
"url": "https://id.idfy.io?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"status": "created",
"created": "2020-03-19T11:16:53Z",
"expires": "2020-03-19T11:26:53Z",
"allowedProviders": [
"no_bankid_mobile",
"no_bankid_netcentric"
],
"language": "en",
"flow": "redirect",
"include": [
"name",
"date_of_birth",
"nin"
],
"redirectSettings": {
"successUrl": "https://example.com/success",
"abortUrl": "https://example.com/abort",
"errorUrl": "https://example.com/error"
},
"externalReference": "123456789"
}
}
}
},
"x-idfy-employeesonly": false
}
},
"/identification/v2/sessions/{id}/invalidate": {
"post": {
"tags": [
"Sessions"
],
"summary": "Invalidate session",
"description": "Invalidates the specified identification session.",
"operationId": "identification/v2/InvalidateSession",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "The session's unique identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Success"
}
},
"x-idfy-employeesonly": false
}
}
},
"definitions": {
"IdentificationResponse": {
"description": "The reponse for the identity process. Contains users name, id number etc",
"type": "object",
"properties": {
"Name": {
"description": "The fullname of the user as reported back from the IdentityProvider",
"type": "string"
},
"FirstName": {
"description": "The first name of the user",
"type": "string"
},
"MiddleName": {
"description": "The middle name of the user (not always available)",
"type": "string"
},
"LastName": {
"description": "The last name of the user",
"type": "string"
},
"DateOfBirth": {
"description": "The users date of birth (not always available)",
"type": "string"
},
"Status": {
"description": "The status of the identification process. If not success the identification process is not completed.",
"enum": [
"UNKNOWN",
"SUCCESS",
"ERROR",
"USERABORTED",
"INVALIDATED",
"TIMEOUT",
"CREATED",
"USERINITIATED"
],
"type": "string"
},
"SocialSecurityNumber": {
"description": "The social security number for the user (if allowed and if the GetSocialSecurityNumber is set to true in the request)",
"type": "string"
},
"IdentityProviderUniqueId": {
"description": "The uniqueID from the e-ID, this ID is unique for the user and is the same every time the user logs on. This is not a sensitiv ID and you could store this to identify the user in you database.\r\nRemark: The Swedish BankID do not have an unique ID.",
"type": "string"
},
"IdentityProvider": {
"description": "The identityprovider type (Norwegian BanKID, SwedishBankID, Nemid, etc)",
"enum": [
"UNKNOWN",
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"SWE_BANKID_MOBILE",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"FI_MOBIILIVARMENNE",
"BE_ITSME",
"FI_FTN"
],
"type": "string"
},
"Error": {
"$ref": "#/definitions/Error",
"description": "Information about error if the identification process failed. (Only set if an error occured, if not is null)"
},
"EnvironmentInfo": {
"$ref": "#/definitions/EnvironmentInfo",
"description": "Information about the users environment as seen by IdentiSign, can be used to compare with own data."
},
"MetaData": {
"description": "A dicitonary with extra information from each identityprovider, and extra services. See developer documentation for more information",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"RequestId": {
"description": "The RequestId",
"type": "string"
}
},
"example": {
"Name": "Wayne, Bruce Thomas",
"FirstName": "Bruce",
"MiddleName": "Thomas",
"LastName": "Wayne",
"DateOfBirth": "311271",
"Status": "SUCCESS",
"SocialSecurityNumber": "23071212345",
"IdentityProviderUniqueId": "9578-6000-4-48855",
"IdentityProvider": "NO_BANKID_WEB",
"EnvironmentInfo": {
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 10_0_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) Mobile/14A456",
"IPAddress": "192.168.1.0"
},
"MetaData": {
"no.personal.info": "JSON data"
},
"RequestId": "25191832985138881678wuuPNTgWL4Aq7RsIemzU8umZSsYNWcEFH1PbCVkdfHZjb6tfnyeTo4mDcvOoEP0z4zvvpcx0zoriRdYbETGLLwHJPkFXRjlRs0kpgeKvANFKkHA0CJGGFYQpbTfht08riaJcpKoRY4vHRJjANxfITbS7bYlFTFR37PEAqcsArnVrcuNyjnvp"
}
},
"Error": {
"description": "Error details information",
"type": "object",
"properties": {
"NativeErrorCode": {
"description": "The error code from the Identity provider",
"type": "string"
},
"ErrorCode": {
"description": "The error code for the error",
"type": "string"
},
"ErrorMessage": {
"description": "Error message",
"type": "string"
}
}
},
"EnvironmentInfo": {
"description": "Information aboute users enviroment",
"type": "object",
"properties": {
"UserAgent": {
"description": "The users user-agent (browser/device)",
"type": "string"
},
"IPAddress": {
"description": "The IP-address of the user",
"type": "string"
}
}
},
"CreateIdentificationRequest": {
"description": "Creates a Identity request",
"required": [
"ReturnUrls"
],
"type": "object",
"properties": {
"IdentityProvider": {
"description": "The identityprovider to use for the identification, if not set the user will get a list of all the e-ID assosiated with your account to choose from.",
"enum": [
"UNKNOWN",
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"SWE_BANKID_MOBILE",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"FI_MOBIILIVARMENNE",
"BE_ITSME",
"FI_FTN"
],
"type": "string"
},
"ReturnUrls": {
"$ref": "#/definitions/ReturnUrls",
"description": "The return urls to be redirected to after the identification process is done"
},
"iFrame": {
"$ref": "#/definitions/iFrameSettings",
"description": "If the identity process should be done in an iframe this settings object would have to set. The redirect is then done in javascript."
},
"Language": {
"description": "The language to be used for the identification process, if not set the language of the users browser will be used.",
"enum": [
"NO",
"EN",
"SV",
"DA",
"FI"
],
"type": "string"
},
"GetSocialSecurityNumber": {
"description": "Should the socialsecuritynumber be fetched from the identityprovider? Beware that there is an extra cost of doing this every time and one need permission to do it.",
"type": "boolean"
},
"PreFilledSocialSecurityNumber": {
"description": "If this is specified then the client will be prefilled with this value. (supported by Norwegian BankID, NemID and Tupas)",
"type": "string"
},
"PageTitle": {
"description": "Title of the identification page (Used when redirecting on larger devices). Not used in iFrame mode",
"type": "string"
},
"ExternalReference": {
"description": "The merchants reference to the identification process, this will also be used to identify an identification in a detailed invoice. It is an advantage if this is unique for each API call.",
"type": "string"
},
"Addonservices": {
"description": "List of addon data that can be orderd. The result will be in MetaData list of the reponse",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"IdentityProvider": "NO_BANKID_WEB",
"ReturnUrls": {
"Error": "https://secure.wayneenterprises.com/auth/error.aspx?status=[0]",
"Abort": "https://secure.wayneenterprises.com/auth/abort.aspx?requestid=[1]&externalid=[2]",
"Success": "https://secure.wayneenterprises.com/auth/success.aspx?requestid=[1]&externalid=[2]"
},
"iFrame": {
"Domain": "secure.wayneenterprises.com",
"WebMessaging": true
},
"Language": "NO",
"GetSocialSecurityNumber": true,
"ExternalReference": "765a7ed2d95c4000b14d7a48eb267546",
"Addonservices": {
"no.personal.info": ""
}
}
},
"ReturnUrls": {
"description": "Return urls for the identity request",
"required": [
"Error",
"Abort",
"Success"
],
"type": "object",
"properties": {
"Error": {
"description": "The url to be redirected to if the identification process fails. This url supports the following placeholders: [0] statuscode, [1] requestId, [2] ExternalReference (your unique id).",
"type": "string"
},
"Abort": {
"description": "The url to be redirected to if the user aborts the identification process. This url supports the following placeholders: [1] requestId, [2] ExternalReference (your unique id).",
"type": "string"
},
"Success": {
"description": "The return urls to be redirected to after the identification process is a success. This url supports the following placeholders: [1] requestId, [2] ExternalReference (your unique id).",
"type": "string"
}
}
},
"iFrameSettings": {
"description": "iFrame settings\r\nREMARK! If using iframe the parent site have to be on https",
"required": [
"Domain"
],
"type": "object",
"properties": {
"Domain": {
"description": "The domain of the site hosting the iFrame, this is used for the CSP policy and must be correct.",
"type": "string"
},
"WebMessaging": {
"description": "Should WebMessaging be used for redirect of the iFrame parent, modern browsers have some issues with childs redirecting parents without the same origin. To use this include this script: https://signerecommon.blob.core.windows.net/files/signereid_webmessaging.js",
"type": "boolean"
},
"Height": {
"format": "int32",
"description": "Height of the frame when used in iFrame.",
"type": "integer"
}
}
},
"CreateIdentificationResponse": {
"description": "The response of the Create Identitiy request",
"type": "object",
"properties": {
"Url": {
"description": "The url to use as src for iframe or to redirect the user to",
"type": "string"
},
"RequestId": {
"description": "Requestid used to get the reponse form server afterwards",
"type": "string"
}
},
"example": {
"Url": "https://id.signere.no/NoBankIDMobile/Start?sessionid=3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2&providerId=c4ab63ae-81b6-49d2-b75c-a17301071188&iframe=False&webmessaging=False&language=NO&errorUrl=aHR0cHM6Ly9pZHRlc3Quc2lnbmVyZS5uby90ZXN0L2Vycm9yP3N0YXR1cz1bMF0%3D&",
"RequestId": "25191832985138881678wuuPNTgWL4Aq7RsIemzU8umZSsYNWcEFH1PbCVkdfHZjb6tfnyeTo4mDcvOoEP0z4zvvpcx0zoriRdYbETGLLwHJPkFXRjlRs0kpgeKvANFKkHA0CJGGFYQpbTfht08riaJcpKoRY4vHRJjANxfITbS7bYlFTFR37PEAqcsArnVrcuNyjnvp"
}
},
"IdentificationCompleteResponse": {
"type": "object",
"properties": {
"Done": {
"description": "Is the idenfication process done?",
"type": "boolean"
}
}
},
"InvalidateIdentificationRequest": {
"description": "Invalidates a identifyrequest so that it cannot be used twice.",
"required": [
"RequestId"
],
"type": "object",
"properties": {
"RequestId": {
"description": "The requestid of the identification process",
"type": "string"
}
},
"example": {
"RequestId": "25191832985138881678wuuPNTgWL4Aq7RsIemzU8umZSsYNWcEFH1PbCVkdfHZjb6tfnyeTo4mDcvOoEP0z4zvvpcx0zoriRdYbETGLLwHJPkFXRjlRs0kpgeKvANFKkHA0CJGGFYQpbTfht08riaJcpKoRY4vHRJjANxfITbS7bYlFTFR37PEAqcsArnVrcuNyjnvp"
}
},
"IdentificationLogItem": {
"description": "An identification historic item",
"type": "object",
"properties": {
"Id": {
"description": "The sessionID for the identitication",
"type": "string"
},
"Name": {
"description": "The fullname of the user as reported back from the IdentityProvider if the identification was a success",
"type": "string"
},
"Status": {
"description": "The status of the identification process. If not success the identification process is not completed.",
"enum": [
"UNKNOWN",
"SUCCESS",
"ERROR",
"USERABORTED",
"INVALIDATED",
"TIMEOUT",
"CREATED",
"USERINITIATED"
],
"type": "string"
},
"ClientIp": {
"description": "The IP-address of the user",
"type": "string"
},
"UserAgent": {
"description": "The users user-agent (browser/device)",
"type": "string"
},
"IdentityProviderType": {
"description": "The identityprovider type (Norwegian BanKID, SwedishBankID, Nemid, etc)",
"type": "string"
},
"Language": {
"description": "The language used for the identification process",
"type": "string"
},
"Externalid": {
"description": "The merchants reference to the identification process, this will also be used to identify an identification in a detailed invoice.",
"type": "string"
},
"Errorcode": {
"description": "The error code for the error",
"type": "string"
},
"Timestamp": {
"format": "date-time",
"description": "The timestamp for the creation of the identification process",
"type": "string"
},
"iFrame": {
"description": "Was an iFrame used",
"type": "boolean"
},
"SocialSecurityNumber": {
"description": "Was social securitynumber fetched",
"type": "boolean"
},
"AccountId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
},
"example": {
"Id": "2519011552909132317BrJ6VqOrcBYfwmgQ2eypM5XP7DEbCm8",
"Name": "Bruce Wayne",
"Status": "SUCCESS",
"ClientIp": "192.168.1.1",
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
"IdentityProviderType": "NO_BANKID_WEB",
"Language": "NO",
"Externalid": "gtWEH8euBHeSWPTcjwB0Bg5o1mjsH106wmjTDMxoFnadzvNSsnSSY0zbJTpy",
"Timestamp": "2020-02-29T07:36:38.7970134Z",
"iFrame": false,
"SocialSecurityNumber": false,
"AccountId": "00000000-0000-0000-0000-000000000000"
}
},
"ListResult[IdentificationLogItem]": {
"type": "object",
"properties": {
"NextLink": {
"description": "Link to the next results if not set there are less then the return limit of 1000",
"type": "string"
},
"TotalLinks": {
"format": "int32",
"description": "The total amount of links (pages) for the list",
"type": "integer"
},
"List": {
"description": "List of results",
"type": "array",
"items": {
"$ref": "#/definitions/IdentificationLogItem"
}
}
},
"example": {
"NextLink": "https://id.signere.no/history/1dd0f6f9-4221-4604-8516-a30f00aef4e5/filter?year=2017&month=0&day=0&skip=1",
"TotalLinks": 5,
"List": [
{
"Id": "2519011552909132317BrJ6VqOrcBYfwmgQ2eypM5XP7DEbCm8",
"Name": "Bruce Wayne",
"Status": "SUCCESS",
"ClientIp": "192.168.1.1",
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
"IdentityProviderType": "NO_BANKID_WEB",
"Language": "NO",
"Externalid": "gtWEH8euBHeSWPTcjwB0Bg5o1mjsH106wmjTDMxoFnadzvNSsnSSY0zbJTpy",
"Timestamp": "2020-02-29T07:36:38.8073762Z",
"iFrame": false,
"SocialSecurityNumber": false,
"AccountId": "00000000-0000-0000-0000-000000000000"
},
{
"Id": "2519011552909132317BrJ6VqOrcBYfwmgQ2eypM5XP7DEbCm8",
"Name": "Joker",
"Status": "ERROR",
"ClientIp": "192.168.1.1",
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36",
"IdentityProviderType": "FI_TUPAS",
"Language": "NO",
"Externalid": "gtWEH8euBHeSWPTcjwB0Bg5o1mjsH106wmjTDMxoFnadzvNSsnSSY0zbJTpy",
"Errorcode": "TIMEOUT",
"Timestamp": "2020-02-29T07:36:38.8073762Z",
"iFrame": false,
"SocialSecurityNumber": false,
"AccountId": "00000000-0000-0000-0000-000000000000"
}
]
}
},
"CreateBankIDMobileRequest": {
"description": "Creates a BankID mobile identification process",
"required": [
"MobileNumber",
"DateOfBirth"
],
"type": "object",
"properties": {
"MobileNumber": {
"description": "Mobile number for the user that is to be identified",
"pattern": "[0-9]{1,8}",
"type": "string"
},
"DateOfBirth": {
"description": "Date of birth for the user that is to be identified",
"pattern": "[0-9]{1,6}",
"type": "string"
},
"GetSocialSecurityNumber": {
"description": "Should the socialsecuritynumber be fetched from the identityprovider? Beware that there is an extra cost of doing this every time and one need permission to do it.",
"type": "boolean"
},
"ExternalReference": {
"description": "The merchants reference to the identification process",
"type": "string"
},
"Addonservices": {
"description": "List of addon data that can be orderd. The result will be in MetaData list of the reponse",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"example": {
"MobileNumber": "99887766",
"DateOfBirth": "071283",
"GetSocialSecurityNumber": true,
"ExternalReference": "765a7ed2d95c4000b14d7a48eb267546",
"Addonservices": {
"no.personal.info": ""
}
}
},
"CreateBankIDMobileResponse": {
"description": "The reponse of the create BankID mobile request",
"type": "object",
"properties": {
"RequestId": {
"description": "Signere requestid used to get the reponse form server afterwards",
"type": "string"
},
"MerchantRef": {
"description": "The merchant ref to show to the end user (SNILL BANK)",
"type": "string"
},
"Error": {
"$ref": "#/definitions/Error",
"description": "Information about error if the identification process failed. (Only set if an error occured, if not is null)"
},
"OK": {
"description": "Status if the request started without errors",
"type": "boolean"
},
"InvalidMobileNumberOrDateOfBirth": {
"description": "Indicates if the Mobile number of the date of birth was invalid. These could be 2 things: \r\n1 the user does not have BankID mobile, \r\n2. Wrong input data (the combination of mobile and date of birth does not match",
"type": "boolean"
}
},
"example": {
"RequestId": "25191832985138881678wuuPNTgWL4Aq7RsIemzU8umZSsYNWcEFH1PbCVkdfHZjb6tfnyeTo4mDcvOoEP0z4zvvpcx0zoriRdYbETGLLwHJPkFXRjlRs0kpgeKvANFKkHA0CJGGFYQpbTfht08riaJcpKoRY4vHRJjANxfITbS7bYlFTFR37PEAqcsArnVrcuNyjnvp",
"MerchantRef": "SNILL BANK",
"Error": {
"NativeErrorCode": "C161",
"ErrorCode": "NO_BANKID_NOT_VALID_MOBILE_OR_DATEOFBIRTH",
"ErrorMessage": "Invalid mobile number and/or date of birth (Error code: C161)"
},
"OK": false,
"InvalidMobileNumberOrDateOfBirth": true
}
},
"AttachmentRequest": {
"required": [
"fileName",
"title",
"data"
],
"type": "object",
"properties": {
"fileName": {
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"type": "string"
},
"title": {
"description": "The title of the attachment which will be presented to the user.",
"type": "string"
},
"data": {
"description": "Base64-encoded attachment (UTF-8-encoded)",
"type": "string"
},
"convertToPdf": {
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types.",
"type": "boolean"
},
"signers": {
"description": "An optional list of signers that should be able to see / sign the attachment.",
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"description": {
"description": "An optional description of the attachment.",
"type": "string"
},
"type": {
"$ref": "#/definitions/AttachmentType",
"description": "The type of attachment. Choose between the following:\r\n* show_accept: The signer will see the attachment before signing the main document (is default now)\r\n* read_accept: The signer have to see the entire document before they can continue, \r\n* sign: The signer has to sign the attachment (extra cost per signature)"
}
},
"example": {
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla...",
"type": "show_accept"
}
},
"AttachmentType": {
"enum": [
"show_accept",
"read_accept",
"sign"
],
"type": "string"
},
"AttachmentResponse": {
"required": [
"fileName",
"title",
"data"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The attachment's unique identifier.",
"type": "string"
},
"fileName": {
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"type": "string"
},
"title": {
"description": "The title of the attachment which will be presented to the user.",
"type": "string"
},
"data": {
"description": "Base64-encoded attachment (UTF-8-encoded)",
"type": "string"
},
"convertToPdf": {
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types.",
"type": "boolean"
},
"signers": {
"description": "An optional list of signers that should be able to see / sign the attachment.",
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"description": {
"description": "An optional description of the attachment.",
"type": "string"
},
"type": {
"$ref": "#/definitions/AttachmentType",
"description": "The type of attachment. Choose between the following:\r\n* show_accept: The signer will see the attachment before signing the main document (is default now)\r\n* read_accept: The signer have to see the entire document before they can continue, \r\n* sign: The signer has to sign the attachment (extra cost per signature)"
}
}
},
"AttachmentListItem": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The attachment's unique identifier.",
"type": "string"
},
"title": {
"description": "The title of the attachment which will be presented to the user.",
"type": "string"
},
"description": {
"description": "An optional description of the attachment.",
"type": "string"
},
"type": {
"$ref": "#/definitions/AttachmentType",
"description": "The type of attachment."
},
"fileName": {
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"type": "string"
}
}
},
"UpdateAttachmentRequest": {
"type": "object",
"properties": {
"type": {
"description": "The type of attachment. Choose between the following:\r\n* show_accept: The signer will see the attachment before signing the main document (is default now)\r\n* read_accept: The signer have to see the entire document before they can continue, \r\n* sign: The signer has to sign the attachment (extra cost per signature)",
"enum": [
"show_accept",
"read_accept",
"sign"
],
"type": "string"
},
"fileName": {
"description": "Filename with file extension. We only support PDF for attachments, set `convertToPdf` to `true` if you have a convertible file type.",
"type": "string"
},
"title": {
"description": "The title of the attachment which will be presented to the user.",
"type": "string"
},
"data": {
"description": "Base64-encoded attachment (UTF-8-encoded)",
"type": "string"
},
"convertToPdf": {
"description": "Determines if the attachment should be converted to PDF. See our documentation for supported file types.",
"type": "boolean"
},
"signers": {
"description": "An optional list of signers that should be able to see / sign the attachment.",
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"description": {
"description": "An optional description of the attachment.",
"type": "string"
}
},
"example": {
"type": "show_accept",
"fileName": "Attachment1.pdf",
"title": "Attachment 1 - Type description",
"data": "Base 64 encoded pdf",
"convertToPdf": false,
"description": "This attachment describes bla bla bla..."
}
},
"CreateDocumentRequest": {
"required": [
"title",
"signers",
"dataToSign",
"contactDetails",
"externalId"
],
"type": "object",
"properties": {
"title": {
"maxLength": 300,
"minLength": 0,
"type": "string"
},
"signers": {
"description": "List of signers for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignerRequest"
}
},
"dataToSign": {
"$ref": "#/definitions/DataToSign"
},
"contactDetails": {
"$ref": "#/definitions/ContactDetails"
},
"externalId": {
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"description": {
"description": "The description of the document job.",
"type": "string"
},
"notification": {
"$ref": "#/definitions/Notification"
},
"advanced": {
"$ref": "#/definitions/Advanced"
}
},
"example": {
"title": "Test document",
"signers": [
{
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
],
"dataToSign": {
"title": "Document title",
"description": "Document description",
"base64Content": "VGhpcyB0ZXh0IGNhbiBzYWZlbHkgYmUgc2lnbmVk",
"fileName": "sample.txt",
"convertToPDF": false
},
"contactDetails": {
"email": "test@test.com",
"url": "https://idfy.io"
},
"externalId": "ae7b9ca7-3839-4e0d-a070-9f14bffbbf55",
"description": "This is an important document",
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2020-03-14T05:49:13Z",
"deleteAfterHours": 1
}
}
}
},
"SignerRequest": {
"required": [
"externalSignerId",
"redirectSettings",
"signatureType"
],
"type": "object",
"properties": {
"externalSignerId": {
"description": "Your reference for the signer.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"redirectSettings": {
"$ref": "#/definitions/RedirectSettings",
"description": "Return URLs and domain settings"
},
"signatureType": {
"$ref": "#/definitions/SignatureType"
},
"signerInfo": {
"$ref": "#/definitions/SignerInfo",
"description": "Define the signers name, mobile and email if you are using notifications"
},
"authentication": {
"$ref": "#/definitions/Authentication",
"description": "Do you want the signer to authenticate before they can see the document?"
},
"extraInfo": {
"$ref": "#/definitions/ExtraInfoSignerRequest",
"description": "Collect extra info about the signer (i.e aml address)"
},
"addons": {
"$ref": "#/definitions/AddonSignerRequest",
"description": "Additional signer-addons to use seamlessly with the signature service"
},
"ui": {
"$ref": "#/definitions/UI"
},
"notifications": {
"$ref": "#/definitions/Notifications"
},
"tags": {
"description": "Coming soon.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"format": "int32",
"description": "Optional order of signing for the signer.",
"type": "integer"
},
"required": {
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document.",
"type": "boolean"
},
"signUrlExpires": {
"format": "date-time",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"type": "string"
},
"getSocialSecurityNumber": {
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires certificate with permission to retrieve social security number",
"type": "boolean"
}
},
"example": {
"externalSignerId": "uoiahsd321982983jhrmnec2wsadm32",
"redirectSettings": {
"redirectMode": "donot_redirect"
},
"signatureType": {
"mechanism": "pkisignature",
"onEacceptUseHandWrittenSignature": false
},
"ui": {
"language": "EN",
"dialogs": {
"before": {
"useCheckBox": false,
"title": "Info",
"message": "Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."
}
},
"styling": {
"colorTheme": "Pink",
"spinner": "Cubes",
"hideTopBar": false
}
},
"order": 0,
"required": false,
"getSocialSecurityNumber": false
}
},
"DataToSign": {
"description": "The data that will be signed.",
"required": [
"base64Content",
"fileName"
],
"type": "object",
"properties": {
"title": {
"description": "Document title",
"type": "string"
},
"description": {
"description": "Document description",
"type": "string"
},
"base64Content": {
"description": "Base64-encoded string of the document, UTF-8-encoded. \r\n(this field will be null after we retrieve the initial request, to retrieve the data at a later time you should use the files controller)",
"type": "string"
},
"base64ContentStyleSheet": {
"description": "Stylesheet to be included if you are uploading XML.",
"type": "string"
},
"fileName": {
"description": "The document file name. Must include a valid file extension (.pdf, .xml, .txt, .doc, .docx, .rtf, .ott, odt).",
"maxLength": 100,
"minLength": 3,
"type": "string"
},
"convertToPDF": {
"description": "Determines if the document should be converted to PDF. Supported formats are word documents, rich text format, and OpenOffice (.doc, .docx, .rtf, .odt, .ott).\r\nRemark: When using this, the converted document (and not the original) is the one that will be signed.",
"type": "boolean"
},
"packaging": {
"$ref": "#/definitions/Packaging"
}
}
},
"ContactDetails": {
"description": "The company's contact information.",
"required": [
"email"
],
"type": "object",
"properties": {
"name": {
"description": "The name of the company.",
"type": "string"
},
"phone": {
"description": "The phone number of the company.",
"type": "string"
},
"email": {
"description": "The email address of the company.",
"type": "string"
},
"url": {
"description": "The URL to the company's website.",
"type": "string"
}
}
},
"Notification": {
"description": "Settings for custom notification texts as well as additional email addresses to receive the signed document under finalReceipt. Remark: Also requires you to setup notifications for each signer you want to notify.",
"type": "object",
"properties": {
"signRequest": {
"$ref": "#/definitions/SignRequest"
},
"reminder": {
"$ref": "#/definitions/Reminder"
},
"signatureReceipt": {
"$ref": "#/definitions/SignatureReceipt"
},
"finalReceipt": {
"$ref": "#/definitions/FinalReceipt"
},
"canceledReceipt": {
"$ref": "#/definitions/CanceledReceipt"
},
"expiredReceipt": {
"$ref": "#/definitions/ExpiredReceipt"
}
}
},
"Advanced": {
"description": "Optional settings for advanced configuration.",
"type": "object",
"properties": {
"tags": {
"description": "A list of tags to add to the document. These tags can be used to query for document data and will also be added to all events that are triggered for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"attachments": {
"format": "int32",
"description": "The number of attachments this document will have. Attachments can be added [here](#operation/Attachment_Create) after the document is created.\r\nIf you set this value to 3, you MUST upload 3 attachments before anyone can sign the document.",
"type": "integer"
},
"requiredSignatures": {
"format": "int32",
"description": "The number of signatures required before the document can be sealed and marked as completed.",
"type": "integer"
},
"createdByApplication": {
"description": "The name of the application that created the document. Used for Idfy statistics.",
"type": "string"
},
"getSocialSecurityNumber": {
"description": "Determines if the social security number of all the signers should be retrieved after a successful signature.\r\nRequires a certificate with permission to retrieve SSN.",
"type": "boolean"
},
"extraInfo": {
"$ref": "#/definitions/ExtraInfoDocumentRequest"
},
"security": {
"$ref": "#/definitions/Security"
},
"timeToLive": {
"$ref": "#/definitions/TimeToLive"
},
"departmentId": {
"description": "The department ID to mark the invoice with.",
"maxLength": 100,
"minLength": 0,
"type": "string"
}
}
},
"RedirectSettings": {
"description": "Settings for redirect.",
"required": [
"redirectMode"
],
"type": "object",
"properties": {
"redirectMode": {
"$ref": "#/definitions/RedirectMode",
"description": "Defines the redirect mode to use for the signer."
},
"domain": {
"description": "The domain your website is hosted on. Required if you specify one of the iframe redirect modes for the signer.",
"type": "string"
},
"error": {
"description": "The URL that the signer is redirected to if something goes wrong. Required if you use redirect for the signer.",
"type": "string"
},
"cancel": {
"description": "The URL that the signer is redirected to if the signing is cancelled. Required if you use redirect for the signer.",
"type": "string"
},
"success": {
"description": "The URL that the signer is redirected to after a successful signing. Required if you use redirect for the signer.",
"type": "string"
}
}
},
"SignatureType": {
"description": "Settings for the allowed signature methods.",
"required": [
"mechanism"
],
"type": "object",
"properties": {
"signatureMethods": {
"description": "A list of signature methods that the signer is allowed to use when signing the document.\r\nIf not specified, all available signature methods for your Idfy account will be displayed to the signer.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignatureMethod"
}
},
"mechanism": {
"$ref": "#/definitions/Mechanisms"
}
}
},
"SignerInfo": {
"description": "Information about the signer.",
"type": "object",
"properties": {
"firstName": {
"description": "The signer's first name.",
"type": "string"
},
"lastName": {
"description": "The signer's last name.",
"type": "string"
},
"email": {
"description": "The signer's email adress. Define this if you are using notifications.",
"type": "string"
},
"socialSecurityNumber": {
"description": "Prefilled social security number.",
"type": "string"
},
"mobile": {
"$ref": "#/definitions/Mobile"
},
"organizationInfo": {
"$ref": "#/definitions/OrganizationInfo"
}
}
},
"Authentication": {
"description": "Authentication settings for the signer.",
"type": "object",
"properties": {
"mechanism": {
"$ref": "#/definitions/AuthMechanism",
"description": "Set the type of authentication you want before the user is allowed to view the document(s), sms otp will use the mobile number specified in signerinfo"
},
"socialSecurityNumber": {
"description": "The signer's social security number.",
"type": "string"
},
"signatureMethodUniqueId": {
"description": "The signer's unique ID for a signature method (for example the Norwegian BankID PID).",
"type": "string"
}
}
},
"ExtraInfoSignerRequest": {
"description": "Settings for extra information to collect about the signer.",
"type": "object",
"properties": {
"types": {
"description": "A list of the extra information you want to order. Certain types require special properties, see documentation for more information. Additional cost will incur (with the exception of Difi company info).",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignerExtraInfo"
}
},
"specialProperties": {
"description": "A set of key-value pairs with special properties, see documentation for more information.",
"type": "object",
"properties": {
"bisnodeUsername": {
"type": "string"
},
"bisnodePassword": {
"type": "string"
},
"includePdfReports": {
"type": "string"
},
"officialUsername": {
"type": "string"
},
"officialPassword": {
"type": "string"
},
"officialReason": {
"type": "string"
},
"officialSystem": {
"type": "string"
},
"amlNationality": {
"type": "string"
},
"amlLanguage": {
"type": "string"
},
"amlMode": {
"type": "string"
}
}
}
}
},
"AddonSignerRequest": {
"type": "object",
"properties": {
"types": {
"description": "A list of the addons you want to order, see documentation for more information. Additional cost will incur",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignerAddon"
}
}
}
},
"UI": {
"description": "UI settings for the signature process.",
"type": "object",
"properties": {
"language": {
"description": "The signer's preferred language. This language will be used when signing the document and in email/SMS notifications.\r\n///",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"dialogs": {
"$ref": "#/definitions/Dialogs"
},
"styling": {
"$ref": "#/definitions/Styling"
}
}
},
"Notifications": {
"description": "Email/SMS notification settings for the signer.",
"type": "object",
"properties": {
"setup": {
"description": "Notification setup for the signer. All notifications defaults to `\"off\"`.",
"type": "object",
"properties": {
"request": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"reminder": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"signatureReceipt": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"finalReceipt": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"canceled": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"expired": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
}
}
},
"mergeFields": {
"description": "If you create your own notifications texts (See the root object -> Notification), you can create your own merge fields with your own keys. \r\nYou can then specify the text you want to insert in these fields per signer in this dictionary. Set the dictionary key to the same value as the merge field value in your notification text, and the value to the text you want us to merge in.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Packaging": {
"description": "Settings for packaging of the signed document.",
"type": "object",
"properties": {
"signaturePackageFormats": {
"description": "A list of signature formats that will be created and made available for download after the document is signed.\r\nSee our documentation for more information about these formats. The native package format is included automatically (i.e. BankID SDO).",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignaturePackageFormat"
}
},
"padesSettings": {
"$ref": "#/definitions/PadesSettings"
}
}
},
"SignRequest": {
"description": "Email/SMS notifications reminding the signers that they have received a new document to sign.",
"type": "object",
"properties": {
"includeOriginalFile": {
"description": "Determines if you want to include the unsigned main document as an attachment to the email notification.",
"type": "boolean"
},
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"Reminder": {
"description": "Email/SMS notifications reminding the signers that they have an unsigned document.",
"required": [
"chronSchedule"
],
"type": "object",
"properties": {
"chronSchedule": {
"description": "Defines a chron expression that control the interval of the reminders (Use UTC time). We use Quartz cron expressions, read more about it here: http://www.quartz-scheduler.org/documentation/quartz-2.x/tutorials/crontrigger.html.",
"type": "string"
},
"maxReminders": {
"format": "int32",
"description": "The maximum number of reminders to be sent for each signer.",
"type": "integer"
},
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"SignatureReceipt": {
"description": "Email/SMS notifications as a receipt for a successful signature.",
"type": "object",
"properties": {
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"FinalReceipt": {
"description": "Email/SMS notifications as a receipt when a document has received all required signatures.",
"type": "object",
"properties": {
"additionalRecipients": {
"description": "The receipt may be sent to persons that are not a signer on this document, by adding a recipient to this list",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/AdditionalRecipient"
}
},
"includeSignedFile": {
"description": "Determines if you want to include the signed main document as an attachment to the email notification. Not recommended for sensitive documents.",
"type": "boolean"
},
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"CanceledReceipt": {
"description": "Email/SMS notifications when a document has been cancelled and can no longer be signed.",
"type": "object",
"properties": {
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"ExpiredReceipt": {
"description": "Email/SMS notifications when a document has expired and can no longer be signed.",
"type": "object",
"properties": {
"email": {
"description": "A list of custom email texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Email"
}
},
"sms": {
"description": "A list of custom SMS texts to use for the notification. Default texts will be used if not specified.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SMS"
}
}
}
},
"ExtraInfoDocumentRequest": {
"description": "Settings for extra information to collect about the document (e.g. prokura information).",
"type": "object",
"properties": {
"types": {
"description": "A list of the extra information you want to order. Certain types require special properties, see documentation for more information. Additional cost will incur (with the exception of Difi company info).",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/DocumentAddon"
}
},
"specialProperties": {
"description": "A set of key-value pairs with special properties, see documentation for more information.",
"type": "object",
"properties": {
"bisnodeUsername": {
"type": "string"
},
"bisnodePassword": {
"type": "string"
},
"includePdfReports": {
"type": "string"
},
"officialUsername": {
"type": "string"
},
"officialPassword": {
"type": "string"
},
"officialReason": {
"type": "string"
},
"officialSystem": {
"type": "string"
},
"amlNationality": {
"type": "string"
},
"amlLanguage": {
"type": "string"
},
"amlMode": {
"type": "string"
}
}
}
}
},
"Security": {
"description": "Security settings.",
"type": "object",
"properties": {
"oneTimeUse": {
"description": "(Coming soon) Determines if the link is one-time use.",
"type": "boolean"
},
"ipWhiteList": {
"description": "(Coming soon) A list of IP addresses that are allowed to see / sign the document.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"TimeToLive": {
"description": "Time-to-live settings for the document.",
"type": "object",
"properties": {
"deadline": {
"format": "date-time",
"description": "Time at which the document will expire (ISO 8601). The document can not be signed after this time. Default/maximum 45 days.",
"type": "string"
},
"deleteAfterHours": {
"format": "int32",
"description": "How many hours we will keep the document after it is signed or expired (deadline). Default/ maximum 7 days (168 hours). After this timespan the document and files will be permanently deleted on our side.",
"type": "integer"
}
}
},
"RedirectMode": {
"enum": [
"donot_redirect",
"redirect",
"iframe_with_webmessaging",
"iframe_with_redirect",
"iframe_with_redirect_and_webmessaging"
],
"type": "string"
},
"SignatureMethod": {
"enum": [
"no_bankid_mobile",
"no_bankid_netcentric",
"no_buypass",
"se_bankid",
"dk_nemid",
"fi_tupas",
"fi_mobiilivarmenne",
"fi_eid",
"sms_otp",
"unknown"
],
"type": "string"
},
"Mechanisms": {
"enum": [
"pkisignature",
"identification",
"handwritten",
"handwritten_with_identification"
],
"type": "string"
},
"Mobile": {
"description": "The signer's mobile number. Define this if you are using notifications.",
"type": "object",
"properties": {
"countryCode": {
"description": "The country calling code, e.g. `+47` for a norwegian number. Country calling codes on Wikipedia",
"type": "string"
},
"number": {
"description": "The mobile number.",
"type": "string"
}
}
},
"OrganizationInfo": {
"description": "The signer's organization info.",
"type": "object",
"properties": {
"orgNo": {
"type": "string"
},
"companyName": {
"type": "string"
},
"countryCode": {
"type": "string"
}
}
},
"AuthMechanism": {
"enum": [
"off",
"eid",
"smsOtp",
"eidAndSmsOtp"
],
"type": "string"
},
"SignerExtraInfo": {
"enum": [
"vippsAmlPerson"
],
"type": "string"
},
"SignerAddon": {
"enum": [
"secureShare"
],
"type": "string"
},
"Dialogs": {
"description": "Dialogs that will be prestented to the signer in the signature process.",
"type": "object",
"properties": {
"before": {
"$ref": "#/definitions/DialogBefore"
},
"after": {
"$ref": "#/definitions/DialogAfter"
}
}
},
"Styling": {
"description": "Customize styling to make the the signature application look perfect in combination with your own application.",
"type": "object",
"properties": {
"colorTheme": {
"$ref": "#/definitions/Theme",
"description": "The color theme for the application."
},
"themeMode": {
"description": "The theme color mode, specify if you want it dark or light themed. Defaults to light",
"enum": [
"Default",
"Light",
"Dark"
],
"type": "string"
},
"spinner": {
"$ref": "#/definitions/Spinner",
"description": "The type of spinner to show in loading screens."
},
"topBar": {
"description": "Hide the topbar (may be a good choice if you iframe our apps)",
"enum": [
"Default",
"Visible",
"OnlyMenu",
"Hidden"
],
"type": "string"
},
"backgroundColor": {
"description": "Override the application background color (use hexadecimal value)",
"type": "string"
}
}
},
"SignaturePackageFormat": {
"enum": [
"xades",
"pades",
"no_bankid_pades"
],
"type": "string"
},
"PadesSettings": {
"description": "PAdES settings that can be defined if the `\"pades\"` package format is selected.",
"type": "object",
"properties": {
"primaryLanguage": {
"description": "The primary language of the PAdES explanatory page. Defaults to english.",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"secondaryLanguage": {
"description": "The secondary language of the PAdES explanatory page.",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"padesTemplateId": {
"description": "The unique ID of PAdES template to use. Can be used if you have previously created your own custom template.",
"type": "string"
},
"includeSsnInPades": {
"description": "If you set this to true, the signers ssn / national Id will be visible in the pades file, and in the standard_packaging files",
"type": "boolean"
}
}
},
"Email": {
"required": [
"language"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/definitions/Language",
"description": "The language of the email notification."
},
"subject": {
"description": "The email subject.",
"type": "string"
},
"text": {
"description": "The email notification body. Plain text and markdown is supported.",
"type": "string"
},
"senderName": {
"description": "The name to use as email sender.",
"type": "string"
}
}
},
"SMS": {
"required": [
"language"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/definitions/Language",
"description": "The language of the SMS notification."
},
"text": {
"description": "The SMS notification text.",
"type": "string"
},
"sender": {
"description": "The name to use as SMS sender.",
"maxLength": 11,
"type": "string"
}
}
},
"AdditionalRecipient": {
"required": [
"email"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/definitions/Language",
"description": "The language of the email notification."
},
"email": {
"description": "The email address of the recipient",
"type": "string"
},
"customMergeFields": {
"description": "If you have custom merge fields in the email texts, the values can be included here",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"DocumentAddon": {
"enum": [
"rightsAndProkura"
],
"type": "string"
},
"DialogBefore": {
"description": "A dialog that will be presented before the document is signed.",
"type": "object",
"properties": {
"useCheckBox": {
"description": "Determines if a the user must confirm that the dialog message has been read before they can continue.",
"type": "boolean"
},
"formFields": {
"description": "List of input fields presented to signer.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/FormField"
}
},
"title": {
"description": "The title of the dialog.",
"maxLength": 100,
"type": "string"
},
"message": {
"description": "The message body of the dialog.",
"maxLength": 2000,
"type": "string"
}
}
},
"DialogAfter": {
"description": "A dialog that will be presented after the document is signed.",
"type": "object",
"properties": {
"title": {
"description": "The title of the dialog.",
"maxLength": 100,
"type": "string"
},
"message": {
"description": "The message body of the dialog.",
"maxLength": 2000,
"type": "string"
}
}
},
"Theme": {
"enum": [
"Default",
"Black",
"Blue",
"Cyan",
"Dark",
"Lime",
"Neutral",
"Pink",
"Purple",
"Red",
"Teal",
"Indigo",
"LightBlue",
"DeepPurple",
"Green",
"LightGreen",
"Yellow",
"Amber",
"Orange",
"DeepOrange",
"Brown",
"Gray",
"BlueGray",
"OceanGreen",
"GreenOcean"
],
"type": "string"
},
"Spinner": {
"enum": [
"Document",
"Classic",
"Cubes",
"Bounce"
],
"type": "string"
},
"Language": {
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"FormField": {
"description": "A list of questions presented to signer before signing the document.",
"required": [
"description",
"key",
"type"
],
"type": "object",
"properties": {
"description": {
"description": "Description of the form field visible to the signer.",
"maxLength": 100,
"type": "string"
},
"key": {
"description": "Key describing the form field.",
"maxLength": 100,
"type": "string"
},
"type": {
"$ref": "#/definitions/FormType",
"description": "The type of input in this form field. Can be either text or a checkbox."
},
"regex": {
"description": "Regex for validating input in form field. Should begin with /^ and end with $/",
"maxLength": 100,
"type": "string"
},
"required": {
"description": "If input is required in the form field before continuing.",
"type": "boolean"
}
}
},
"FormType": {
"enum": [
"text",
"checkbox"
],
"type": "string"
},
"CreateDocumentResponse": {
"type": "object",
"properties": {
"documentId": {
"format": "uuid",
"description": "The document's unique identifier.",
"type": "string"
},
"signers": {
"description": "List of signers for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/SignerResponse"
}
},
"status": {
"$ref": "#/definitions/Status"
},
"links": {
"description": "HATEOAS extra info links retrieved for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"title": {
"description": "The title of the document job.",
"type": "string"
},
"description": {
"description": "The description of the document job.",
"type": "string"
},
"externalId": {
"description": "Your reference to this document.",
"type": "string"
},
"dataToSign": {
"$ref": "#/definitions/DataToSign",
"description": "The document file data, packaging options, ..."
},
"contactDetails": {
"$ref": "#/definitions/ContactDetails",
"description": "The contact details to the organization responsible for this document"
},
"notification": {
"$ref": "#/definitions/Notification"
},
"advanced": {
"$ref": "#/definitions/Advanced"
}
}
},
"SignerResponse": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The signer's unique identifier.",
"type": "string"
},
"url": {
"description": "The URL that the signer must use to sign the document.",
"type": "string"
},
"documentSignature": {
"$ref": "#/definitions/DocumentSignature"
},
"links": {
"description": "HATEOAS extrainfo links retrieved for signer.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"ui": {
"$ref": "#/definitions/UIResponse"
},
"externalSignerId": {
"description": "Your reference for the signer.",
"type": "string"
},
"redirectSettings": {
"$ref": "#/definitions/RedirectSettings",
"description": "Return URLs and domain settings"
},
"signatureType": {
"$ref": "#/definitions/SignatureType"
},
"signerInfo": {
"$ref": "#/definitions/SignerInfo",
"description": "Define the signers name, mobile and email if you are using notifications"
},
"authentication": {
"$ref": "#/definitions/Authentication",
"description": "Do you want the signer to authenticate before they can see the document?"
},
"extraInfo": {
"$ref": "#/definitions/ExtraInfoSignerRequest",
"description": "Collect extra info about the signer (i.e aml address)"
},
"addons": {
"$ref": "#/definitions/AddonSignerRequest",
"description": "Additional signer-addons to use seamlessly with the signature service"
},
"notifications": {
"$ref": "#/definitions/Notifications"
},
"tags": {
"description": "Coming soon.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"format": "int32",
"description": "Optional order of signing for the signer.",
"type": "integer"
},
"required": {
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document.",
"type": "boolean"
},
"signUrlExpires": {
"format": "date-time",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"type": "string"
},
"getSocialSecurityNumber": {
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires certificate with permission to retrieve social security number",
"type": "boolean"
}
}
},
"Status": {
"description": "The status of the document.",
"type": "object",
"properties": {
"documentStatus": {
"$ref": "#/definitions/DocumentStatus",
"description": "The overall status of the document."
},
"completedPackages": {
"description": "A list of all the completed files/packages for the main document.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/FileFormat"
}
},
"attachmentPackages": {
"description": "A set of key-value pairs with all the completed packages for the signable attachments, where the key is equal to the attachment's ID.",
"type": "object",
"additionalProperties": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/FileFormat"
}
}
}
}
},
"Link": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"rel": {
"type": "string"
},
"contentType": {
"type": "string"
},
"error": {
"type": "string"
},
"resourceStatus": {
"$ref": "#/definitions/ResourceStatus"
}
}
},
"DocumentSignature": {
"description": "The document signature.",
"type": "object",
"properties": {
"signatureMethod": {
"$ref": "#/definitions/SignatureMethod",
"description": "The signature method used to sign the document."
},
"fullName": {
"description": "The signer's full name, retrieved from the signature-method provider.",
"type": "string"
},
"firstName": {
"description": "The signer's first name.",
"type": "string"
},
"lastName": {
"description": "The signer's last name.",
"type": "string"
},
"middleName": {
"description": "The signer's middle name.",
"type": "string"
},
"signedTime": {
"format": "date-time",
"description": "Time at which the signature was registered (ISO 8601).",
"type": "string"
},
"dateOfBirth": {
"description": "The signer's date of birth (yyyy-MM-dd).",
"type": "string"
},
"signatureMethodUniqueId": {
"description": "The signature method unique ID.",
"type": "string"
},
"socialSecurityNumber": {
"$ref": "#/definitions/SocialSecurityNumber"
},
"clientIp": {
"description": "The IP address of the signer.",
"type": "string"
},
"mechanism": {
"$ref": "#/definitions/Mechanisms",
"description": "The signature mechanism used"
},
"personalInfoOrigin": {
"$ref": "#/definitions/PersonalInfoOrigin",
"description": "The origin of the signer name and date of birth in this object"
}
}
},
"UIResponse": {
"type": "object",
"properties": {
"dialogs": {
"$ref": "#/definitions/DialogsResponse"
},
"language": {
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"styling": {
"$ref": "#/definitions/Styling"
}
}
},
"DocumentStatus": {
"enum": [
"unsigned",
"waiting_for_attachments",
"partialsigned",
"signed",
"canceled",
"expired"
],
"type": "string"
},
"FileFormat": {
"enum": [
"unsigned",
"native",
"standard_packaging",
"pades",
"xades"
],
"type": "string"
},
"ResourceStatus": {
"enum": [
"Unknown",
"NotReady",
"Success",
"signatureError",
"NotFound",
"BadInput",
"ServiceUnavailable",
"Unauthorized",
"TimeOut"
],
"type": "string"
},
"SocialSecurityNumber": {
"description": "The signer's social security number. Will be retrieved only when `getSocialSecurityNumber` is specified when creating the document.",
"type": "object",
"properties": {
"value": {
"description": "The social security number.",
"type": "string"
},
"countryCode": {
"description": "ISO 3166-1 Alfa-2 (2 letters) country code.",
"type": "string"
}
}
},
"PersonalInfoOrigin": {
"enum": [
"unknown",
"eid",
"userFormInput"
],
"type": "string"
},
"DialogsResponse": {
"type": "object",
"properties": {
"before": {
"$ref": "#/definitions/DialogBeforeResponse"
},
"after": {
"$ref": "#/definitions/DialogAfter"
}
}
},
"DialogBeforeResponse": {
"type": "object",
"properties": {
"useCheckBox": {
"description": "Determines if a the user must confirm that the dialog message has been read before they can continue.",
"type": "boolean"
},
"formFields": {
"description": "List of form responses from the signer.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/FormFieldResponse"
}
},
"title": {
"description": "The title of the dialog.",
"maxLength": 100,
"type": "string"
},
"message": {
"description": "The message body of the dialog.",
"maxLength": 2000,
"type": "string"
}
}
},
"FormFieldResponse": {
"required": [
"description",
"key",
"type"
],
"type": "object",
"properties": {
"answer": {
"description": "The answer given by the signer.",
"type": "string"
},
"description": {
"description": "Description of the form field visible to the signer.",
"maxLength": 100,
"type": "string"
},
"key": {
"description": "Key describing the form field.",
"maxLength": 100,
"type": "string"
},
"type": {
"$ref": "#/definitions/FormType",
"description": "The type of input in this form field. Can be either text or a checkbox."
},
"regex": {
"description": "Regex for validating input in form field. Should begin with /^ and end with $/",
"maxLength": 100,
"type": "string"
},
"required": {
"description": "If input is required in the form field before continuing.",
"type": "boolean"
}
}
},
"UpdateDocumentRequest": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"notification": {
"$ref": "#/definitions/Notification"
},
"contactDetails": {
"$ref": "#/definitions/ContactDetails"
},
"advanced": {
"$ref": "#/definitions/Advanced"
}
},
"example": {
"title": "Updated title",
"description": "This is an updated description",
"contactDetails": {
"email": "test@test.com",
"url": "https://idfy.io"
},
"advanced": {
"tags": [
"develop",
"fun_with_documents"
],
"attachments": 0,
"requiredSignatures": 0,
"getSocialSecurityNumber": false,
"timeToLive": {
"deadline": "2020-03-14T05:49:13Z",
"deleteAfterHours": 1
}
}
}
},
"DocumentSummary": {
"description": "A summary containing core information about a document",
"type": "object",
"properties": {
"documentId": {
"format": "uuid",
"description": "Document id",
"type": "string"
},
"accountId": {
"format": "uuid",
"description": "Account id",
"type": "string"
},
"title": {
"description": "Document title",
"type": "string"
},
"description": {
"description": "Document description",
"type": "string"
},
"lastUpdated": {
"format": "date-time",
"description": "When was the document last updated (ISO8601)",
"type": "string"
},
"deadline": {
"format": "date-time",
"description": "The sign deadline for the document (ISO8601)",
"type": "string"
},
"signedDate": {
"format": "date-time",
"description": "When was all the signatures processed (ISO8601)",
"type": "string"
},
"status": {
"$ref": "#/definitions/Status",
"description": "Document status"
},
"externalId": {
"description": "External document Id (your Id)",
"type": "string"
},
"documentSignatures": {
"description": "All the signatures received on this document",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedDocumentSignature"
}
},
"requiredSignatures": {
"format": "int32",
"description": "The number of required signatures on the document",
"type": "integer"
},
"currentSignatures": {
"format": "int32",
"description": "How many signatures is completed right now",
"type": "integer"
},
"tags": {
"description": "Document tags",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"attachments": {
"description": "A list of attachment Id's",
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"signers": {
"description": "A list of all the signers on the document",
"uniqueItems": false,
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"created": {
"format": "date-time",
"description": "When the document was created (ISO 8601)",
"type": "string"
}
}
},
"ExtendedDocumentSignature": {
"type": "object",
"properties": {
"signerId": {
"format": "uuid",
"description": "The signer's unique identifier.",
"type": "string"
},
"externalSignerId": {
"description": "Your reference for the signer.",
"type": "string"
},
"signatureMethod": {
"$ref": "#/definitions/SignatureMethod",
"description": "The signature method used to sign the document."
},
"fullName": {
"description": "The signer's full name, retrieved from the signature-method provider.",
"type": "string"
},
"firstName": {
"description": "The signer's first name.",
"type": "string"
},
"lastName": {
"description": "The signer's last name.",
"type": "string"
},
"middleName": {
"description": "The signer's middle name.",
"type": "string"
},
"signedTime": {
"format": "date-time",
"description": "Time at which the signature was registered (ISO 8601).",
"type": "string"
},
"dateOfBirth": {
"description": "The signer's date of birth (yyyy-MM-dd).",
"type": "string"
},
"signatureMethodUniqueId": {
"description": "The signature method unique ID.",
"type": "string"
},
"socialSecurityNumber": {
"$ref": "#/definitions/SocialSecurityNumber"
},
"clientIp": {
"description": "The IP address of the signer.",
"type": "string"
},
"mechanism": {
"$ref": "#/definitions/Mechanisms",
"description": "The signature mechanism used"
},
"personalInfoOrigin": {
"$ref": "#/definitions/PersonalInfoOrigin",
"description": "The origin of the signer name and date of birth in this object"
}
}
},
"CollectionWithPaging[DocumentSummary]": {
"type": "object",
"properties": {
"offset": {
"format": "int32",
"description": "The offset of the current page.",
"type": "integer"
},
"limit": {
"format": "int32",
"description": "The limit of the current paging options.",
"type": "integer"
},
"size": {
"format": "int64",
"description": "The total size of the collection (irrespective of any paging options).",
"type": "integer"
},
"links": {
"$ref": "#/definitions/Links"
},
"data": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/DocumentSummary"
}
}
}
},
"Links": {
"type": "object",
"properties": {
"next": {
"type": "string"
},
"previous": {
"type": "string"
},
"first": {
"type": "string"
}
}
},
"NotificationLogItem": {
"type": "object",
"properties": {
"sentTimeStamp": {
"type": "string"
},
"title": {
"type": "string"
},
"text": {
"type": "string"
},
"messageType": {
"type": "string"
},
"status": {
"type": "string"
},
"fromAddress": {
"type": "string"
},
"receiver": {
"type": "string"
}
}
},
"ManualReminder": {
"required": [
"notificationSetting"
],
"type": "object",
"properties": {
"notificationSetting": {
"$ref": "#/definitions/NotificationSetting",
"description": "Set what kind of reminders to send"
},
"signers": {
"description": "Optional: Define the signers that should receive this reminder (if not signed). Dictionary with signer id as key, you can ovveride the signer email/phone as value",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/SignerOverrides"
}
}
},
"example": {
"notificationSetting": "sendEmail",
"signers": {
"42b0f46c-72c7-49b7-8351-4a9a4e9a9168": null,
"8608af99-e005-401e-8291-debd28974dc4": {
"emailOverride": "overrideemail@test.com"
}
}
}
},
"NotificationSetting": {
"enum": [
"off",
"sendSms",
"sendEmail",
"sendBoth"
],
"type": "string"
},
"SignerOverrides": {
"type": "object",
"properties": {
"emailOverride": {
"description": "Set a new email address on the signer (all fututre notifications to this specific signer will be sent to this email)",
"type": "string"
},
"mobileOverride": {
"$ref": "#/definitions/Mobile"
}
}
},
"UpdateSignerRequest": {
"type": "object",
"properties": {
"externalSignerId": {
"description": "Your reference for the signer.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"redirectSettings": {
"$ref": "#/definitions/RedirectSettings",
"description": "Return URLs and domain settings"
},
"signatureType": {
"$ref": "#/definitions/SignatureType"
},
"signerInfo": {
"$ref": "#/definitions/SignerInfo",
"description": "Define the signers name, mobile and email if you are using notifications"
},
"authentication": {
"$ref": "#/definitions/Authentication",
"description": "Do you want the signer to authenticate before they can see the document?"
},
"extraInfo": {
"$ref": "#/definitions/ExtraInfoSignerRequest",
"description": "Coming soon: Do you want to collect extra info about this specific signer? (for example personal information)"
},
"addons": {
"$ref": "#/definitions/AddonSignerRequest",
"description": "Additional signer-addons to use seamlessly with the signature service"
},
"ui": {
"$ref": "#/definitions/UIResponse"
},
"notifications": {
"$ref": "#/definitions/Notifications"
},
"tags": {
"description": "Coming soon.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"format": "int32",
"description": "Optional order of signing for the signer.",
"type": "integer"
},
"required": {
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document.",
"type": "boolean"
},
"signUrlExpires": {
"format": "date-time",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"type": "string"
}
},
"example": {
"signerInfo": {
"firstName": "Updated",
"lastName": "Name"
},
"order": 0,
"required": false,
"signUrlExpires": "2020-03-15T05:49:13Z"
}
},
"UpdateSignerResponse": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The signer's unique identifier.",
"type": "string"
},
"url": {
"description": "The URL that the signer must use to sign the document.",
"type": "string"
},
"documentSignature": {
"$ref": "#/definitions/DocumentSignature"
},
"links": {
"description": "HATEOAS extrainfo links retrieved for signer.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Link"
}
},
"ui": {
"$ref": "#/definitions/UIResponse"
},
"externalSignerId": {
"description": "Your reference for the signer.",
"type": "string"
},
"redirectSettings": {
"$ref": "#/definitions/RedirectSettings",
"description": "Return URLs and domain settings"
},
"signatureType": {
"$ref": "#/definitions/SignatureType"
},
"signerInfo": {
"$ref": "#/definitions/SignerInfo",
"description": "Define the signers name, mobile and email if you are using notifications"
},
"authentication": {
"$ref": "#/definitions/Authentication",
"description": "Do you want the signer to authenticate before they can see the document?"
},
"extraInfo": {
"$ref": "#/definitions/ExtraInfoSignerRequest",
"description": "Collect extra info about the signer (i.e aml address)"
},
"addons": {
"$ref": "#/definitions/AddonSignerRequest",
"description": "Additional signer-addons to use seamlessly with the signature service"
},
"notifications": {
"$ref": "#/definitions/Notifications"
},
"tags": {
"description": "Coming soon.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"order": {
"format": "int32",
"description": "Optional order of signing for the signer.",
"type": "integer"
},
"required": {
"description": "Determines if the signer is required to sign the document before other signers. Any other signers will not be allowed to sign before all required signers have signed the document.",
"type": "boolean"
},
"signUrlExpires": {
"format": "date-time",
"description": "The time at which the signature URL expires (ISO 8601). Specify this if you want a limited time-to-live for the URL. Defaults to the lifetime of the document.",
"type": "string"
},
"getSocialSecurityNumber": {
"description": "Get social security number for this signer only (The global variable advanced.getSocialSecurityNumber will ovveride this when sat to true).\r\nRequires certificate with permission to retrieve social security number",
"type": "boolean"
}
}
},
"EventType": {
"enum": [
"document_before_deleted",
"document_canceled",
"document_created",
"document_deleted",
"document_expired",
"document_email_opened",
"document_form_partially_signed",
"document_form_signed",
"document_link_opened",
"document_packaged",
"document_partially_signed",
"document_read",
"document_signed",
"resource_created",
"share_created",
"share_deleted",
"share_recipients_authenticated",
"share_recipient_downloaded",
"share_downloaded",
"share_expired",
"deposit_created",
"deposit_terminated",
"deposit_fully_funded",
"deposit_partially_funded",
"deposit_bank_account_created"
],
"type": "string"
},
"PersonAmlResponse": {
"type": "object",
"properties": {
"bisnodeReference": {
"description": "Reference identifying the current request. May be used for tracing",
"type": "string"
},
"sanctionResults": {
"description": "List of all Sanction items with match for the input request.",
"type": "array",
"items": {
"$ref": "#/definitions/PersonSanctionResult"
}
},
"pepResults": {
"description": "List of all PEP items with match for the input request.",
"type": "array",
"items": {
"$ref": "#/definitions/PepResult"
}
},
"verifiedPerson": {
"$ref": "#/definitions/VerifiedPerson",
"description": "Data retrieved before the actual screening (data enhancement)."
},
"message": {
"description": "Response message could for example be: No result from PEP and/or SANCTION screening.",
"type": "string"
},
"Report": {
"description": "Reference to downloadable PDF report (if includeReport is set to true in request)",
"type": "string"
}
},
"example": {
"sanctionResults": [
{
"matchIndicator": 325,
"comment": "(Mother’s name: Masouma Abd al-Rahman. Photo available for inclusion in the INTERPOL-UN Security Council Special Notice)",
"aliasList": [
"Najmuddin Faraj Ahmad",
"Mullah Krekar",
"Fateh Najm Eddine Farraj",
"Faraj Ahmad Najmuddin"
],
"addressList": [
{
"countryName": "Iraq",
"countryCode": "IQ"
},
{
"countryName": "Norway",
"countryCode": "NO",
"street": "10 Testesensgate",
"postCode": "0101",
"city": "Oslo"
}
],
"urlList": [
"http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2006:351:0009:0010:EN:PDF"
],
"provider": "TRAPETS",
"source": "EU_GLOBAL",
"externalId": "3641",
"lastUpdate": "2016-12-15T00:00:00",
"firstUpdate": "2016-01-19T00:00:00",
"name": "Najmuddin Faraj Ahmad",
"gender": "UNKNOWN",
"birthDate": "1956-07-07"
},
{
"matchIndicator": 325,
"comment": "Mother’s name: Masouma Abd al-Rahman. Photo available for inclusion in the INTERPOL-UN Security Council Special Notice. Review pursuant to Security Council resolution 1822 (2008) was concluded on 20 May 2010.",
"aliasList": [
"Mullah Krekar",
"Fateh Najm Eddine Farraj",
"Faraj Ahmad Najmuddin",
"NAJMUDDIN FARAJ AHMAD "
],
"addressList": [
{
"countryName": "Iraq",
"countryCode": "IQ"
},
{
"countryName": "Iraq",
"countryCode": "IQ",
"street": "Olaqloo Sharbajer"
},
{
"countryName": "Norway",
"countryCode": "NO",
"street": "Testesensgate 1",
"postCode": "0101",
"city": "Oslo"
}
],
"provider": "TRAPETS",
"source": "UN_CONSOLIDATED_1",
"externalId": "2762998",
"lastUpdate": "2016-12-15T00:00:00",
"firstUpdate": "2006-12-07T00:00:00",
"name": "Mullah Krekar",
"gender": "UNKNOWN",
"birthDate": "1956-07-07"
}
],
"pepResults": [
{
"matchIndicator": 500,
"title": "Minister for Infrastructure",
"aliasList": [
"Anna Frida Wiktoria Johansson"
],
"addressList": [
{
"countryName": "Sweden",
"countryCode": "SE"
}
],
"urlList": [
"http://www.government.se/government-of-sweden/ministry-of-enterprise-and-innovation/anna-johansson/",
"https://sv.wikipedia.org/wiki/Anna_Johansson_(socialdemokrat)"
],
"provider": "TRAPETS",
"source": "PEP_Edge",
"externalId": "SE.Government-372",
"lastUpdate": "2016-12-15T00:00:00",
"name": "Anna Frida Wiktoria Johansson",
"gender": "UNKNOWN",
"birthDate": "1971-05-29"
}
],
"verifiedPerson": {
"provider": "BISNODE",
"name": "Anna Frida Wiktoria Johansson",
"gender": "FEMALE",
"natIdNo": "195001011234",
"nationality": "NO",
"birthDate": "1971-05-29"
},
"message": "NO MESSAGE",
"Report": "reference to PDF report, sealed and timestamped."
}
},
"PersonSanctionResult": {
"description": "List of all Sanction items with match for the input request.",
"type": "object",
"properties": {
"matchIndicator": {
"format": "int32",
"description": "Quality indicator of match. Higher number means better match.",
"type": "integer"
},
"title": {
"description": "May be a text string denoting title of position, job title, etc",
"type": "string"
},
"function": {
"description": "Additional details about what the person does",
"type": "string"
},
"comment": {
"description": "A comment of some kind may be present in some lists",
"type": "string"
},
"aliasList": {
"description": "Name aliases for the person. May be none, one or more.",
"type": "array",
"items": {
"type": "string"
}
},
"addressList": {
"description": "List of addresses found in the lists",
"type": "array",
"items": {
"$ref": "#/definitions/AddressList"
}
},
"urlList": {
"description": "URLs to source documents (May be used for further investigations)",
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"description": "Name of data provider",
"type": "string"
},
"source": {
"description": "The name of the source list, e.g. 'EU_GLOBAL', 'PEP_Edge', 'UN_CONSOLIDATED'",
"type": "string"
},
"externalId": {
"description": "External identification",
"type": "string"
},
"lastUpdate": {
"format": "date-time",
"description": "Date of last update",
"type": "string"
},
"firstUpdate": {
"format": "date-time",
"description": "Date of first update",
"type": "string"
},
"name": {
"description": "Name of person",
"type": "string"
},
"gender": {
"description": "Gender of person",
"enum": [
"MALE",
"FEMALE",
"UNKNOWN"
],
"type": "string"
},
"natIdNo": {
"description": "National Identification Number",
"type": "string"
},
"nationality": {
"description": "Two-letter code as specified in the ISO 3166 standard",
"type": "string"
},
"birthDate": {
"description": "Date of birth for the person",
"type": "string"
}
}
},
"PepResult": {
"description": "List of all PEP items with match for the input request.",
"type": "object",
"properties": {
"matchIndicator": {
"format": "int32",
"description": "Quality indicator of match. Higher number means better match.",
"type": "integer"
},
"title": {
"description": "May be a text string denoting title of position, job title, etc",
"type": "string"
},
"function": {
"description": "Additional details about what the person does",
"type": "string"
},
"comment": {
"description": "A comment of some kind may be present in some lists",
"type": "string"
},
"aliasList": {
"description": "Name aliases for the person. May be none, one or more.",
"type": "array",
"items": {
"type": "string"
}
},
"addressList": {
"description": "List of addresses found in the lists",
"type": "array",
"items": {
"$ref": "#/definitions/AddressList"
}
},
"urlList": {
"description": "URLs to source documents (May be used for further investigations)",
"type": "array",
"items": {
"type": "string"
}
},
"provider": {
"description": "Name of data provider",
"type": "string"
},
"source": {
"description": "The name of the source list, e.g. 'EU_GLOBAL', 'PEP_Edge', 'UN_CONSOLIDATED'",
"type": "string"
},
"externalId": {
"description": "External identification",
"type": "string"
},
"lastUpdate": {
"format": "date-time",
"description": "Date of last update",
"type": "string"
},
"firstUpdate": {
"format": "date-time",
"description": "Date of first update",
"type": "string"
},
"name": {
"description": "Name of person",
"type": "string"
},
"gender": {
"description": "Gender of person",
"enum": [
"MALE",
"FEMALE",
"UNKNOWN"
],
"type": "string"
},
"natIdNo": {
"description": "National Identification Number",
"type": "string"
},
"nationality": {
"description": "Two-letter code as specified in the ISO 3166 standard",
"type": "string"
},
"birthDate": {
"description": "Date of birth for the person",
"type": "string"
}
}
},
"VerifiedPerson": {
"description": "Data retrieved before the actual screening (data enhancement).",
"type": "object",
"properties": {
"status": {
"description": "Person status code, e.g. DECEASED, EMIGRATED",
"type": "array",
"items": {
"enum": [
"UNKNOWN",
"EMIGRATED",
"BANKRUPT",
"PROTECTED",
"NO_ADDRESS",
"DECEASED",
"GUARDIANSHIP"
],
"type": "string"
}
},
"deceasedDate": {
"format": "date-time",
"description": "Date of death",
"type": "string"
},
"emigratedDate": {
"format": "date-time",
"description": "Date of emigration",
"type": "string"
},
"roles": {
"description": "Role in company",
"type": "array",
"items": {
"$ref": "#/definitions/Role"
}
},
"provider": {
"description": "Name of data provider",
"type": "string"
},
"name": {
"description": "Name of person",
"type": "string"
},
"gender": {
"description": "Gender of person",
"enum": [
"MALE",
"FEMALE",
"UNKNOWN"
],
"type": "string"
},
"natIdNo": {
"description": "National Identification Number",
"type": "string"
},
"nationality": {
"description": "Two-letter code as specified in the ISO 3166 standard",
"type": "string"
},
"birthDate": {
"description": "Date of birth for the person",
"type": "string"
}
}
},
"AddressList": {
"type": "object",
"properties": {
"countryName": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"street": {
"type": "string"
},
"postCode": {
"type": "string"
},
"city": {
"type": "string"
}
}
},
"Role": {
"type": "object",
"properties": {
"code": {
"enum": [
"Unknown",
"CHAIRMAN_OF_THE_BOARD",
"DEPUTY_CHAIRMAN_OF_THE_BOARD",
"BOARD_MEMBER",
"EMPLOYEES_REPRESENTATIVE",
"DEPUTY_BOARD_MEMBER",
"OBSERVER",
"REPRESENTATIVE_FOREIGN_ENTITY",
"LIABLE_PARTNER",
"CEO",
"COMPANY_SECRETARY",
"AUDITOR",
"AUDIT_EXEMPTION",
"CERTIFIED_ACCOUNTANT",
"CONTACT"
],
"type": "string"
},
"description": {
"type": "string"
}
}
},
"CompanyAmlResponse": {
"type": "object",
"properties": {
"bisnodeReference": {
"description": "Reference identifying the current request. May be used for tracing",
"type": "string"
},
"verifiedCompany": {
"$ref": "#/definitions/VerifiedCompany",
"description": "Data retrieved before the actual screening (data enhancement)."
},
"sanctionResults": {
"description": "List of all Sanction items with match for the input request.",
"type": "array",
"items": {
"$ref": "#/definitions/CompanySanctionResult"
}
},
"message": {
"description": "Response message could for example be: No result from PEP and/or SANCTION screening.",
"type": "string"
},
"ownersAndBoardMembers": {
"$ref": "#/definitions/OwnersAndBoardMembers",
"description": "Results for owners and board members"
},
"Report": {
"description": "Reference to downloadable PDF report (if includeReport is set to true in request)",
"type": "string"
}
}
},
"VerifiedCompany": {
"description": "Data retrieved before the actual screening (data enhancement).",
"type": "object",
"properties": {
"regNo": {
"description": "Business registration number",
"type": "string"
},
"dunsNo": {
"description": "D-U-N-S number",
"type": "string"
},
"status": {
"description": "Status code",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "Name of company",
"type": "string"
},
"nationality": {
"description": "Two-letter code as specified in the ISO 3166 standard",
"type": "string"
},
"provider": {
"description": "Name of data provider",
"type": "string"
}
}
},
"CompanySanctionResult": {
"description": "List of all Sanction items with match for the input request.",
"type": "object",
"properties": {
"matchIndicator": {
"format": "int32",
"description": "Quality indicator of match. Higher number means better match.",
"type": "integer"
},
"title": {
"description": "May be a text string denoting title of position, job title, etc",
"type": "string"
},
"function": {
"description": "Additional details about what the company does",
"type": "string"
},
"comment": {
"description": "A comment of some kind may be present in some lists",
"type": "string"
},
"aliasList": {
"description": "Name aliases for the company. May be none, one or more.",
"type": "array",
"items": {
"type": "string"
}
},
"addressList": {
"description": "List of addresses found in the lists",
"type": "array",
"items": {
"$ref": "#/definitions/AddressList"
}
},
"urlList": {
"description": "URLs to source documents (May be used for further investigations)",
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"description": "The name of the source list, e.g. 'EU_GLOBAL', 'PEP_Edge', 'UN_CONSOLIDATED'",
"type": "string"
},
"externalId": {
"description": "External identification",
"type": "string"
},
"lastUpdate": {
"format": "date-time",
"description": "Date of last update",
"type": "string"
},
"firstUpdate": {
"format": "date-time",
"description": "Date of first update",
"type": "string"
},
"name": {
"description": "Name of company",
"type": "string"
},
"nationality": {
"description": "Two-letter code as specified in the ISO 3166 standard",
"type": "string"
},
"provider": {
"description": "Name of data provider",
"type": "string"
}
}
},
"OwnersAndBoardMembers": {
"type": "object",
"properties": {
"persons": {
"description": "List of person results, same structure as documented in chapter 5.4 B2C Response, exluding “bisnodeReference”",
"type": "array",
"items": {
"$ref": "#/definitions/PersonAmlResponse"
}
},
"companies": {
"description": "List of company results, same structure as current table, excluding “bisnodeReference” and “ownersAndBoardMembers”",
"type": "array",
"items": {
"$ref": "#/definitions/CompanyAmlResponse"
}
}
}
},
"DifiResponse": {
"type": "object",
"properties": {
"Organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/CompanyInfoDifiResponse"
}
},
"RawData": {
"type": "string"
},
"RequestId": {
"type": "string"
}
},
"example": {
"Organizations": [
{
"OrgNr": "911111111",
"OrgName": "Klokkeservice AS",
"Address": "Testveien 4",
"PostalCode": "5050",
"City": "Bergen",
"Website": "www.somepage.no",
"Country": "Norge"
}
],
"RawData": "This Json-string contains all the data received from difi",
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
},
"CompanyInfoDifiResponse": {
"type": "object",
"properties": {
"OrgNr": {
"type": "string"
},
"OrgName": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Website": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"CompanyInformationResponse": {
"type": "object",
"properties": {
"OrgNr": {
"type": "string"
},
"OrgName": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"RawJson": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"RequestId": {
"type": "string"
}
},
"example": {
"OrgNr": "911111111",
"OrgName": "Klokkeservice AS",
"Address": "Testveien 4",
"PostalCode": "5050",
"City": "Bergen",
"Country": "Norge",
"RawJson": "This Json-string contains all the data received from matchit",
"Phone": "12345678",
"Mobile": "87654321",
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
},
"CreditCheckCompanyResponse": {
"type": "object",
"properties": {
"OrgNumber": {
"format": "int32",
"type": "integer"
},
"OrgName": {
"type": "string"
},
"Address": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"IncorporationDate": {
"format": "date-time",
"type": "string"
},
"ChairMan": {
"type": "string"
},
"CEO": {
"type": "string"
},
"Economy": {
"$ref": "#/definitions/Economy"
},
"BisnodeRatingCode": {
"type": "string"
},
"BisnodeRatingDescription": {
"type": "string"
},
"CreditLimit": {
"format": "double",
"type": "number"
},
"PaymentDefaults": {
"type": "string"
},
"RequestId": {
"type": "string"
},
"Report": {
"type": "string"
},
"DetailedInformation": {
"$ref": "#/definitions/HentForetakResponse"
},
"NumberOfPaymentDefaults": {
"format": "int32",
"type": "integer"
}
},
"example": {
"OrgNumber": 911111111,
"OrgName": "Klokkeservice AS",
"Address": "Testveien 4",
"PostalCode": "5050",
"City": "Bergen",
"IncorporationDate": "2001-02-22T00:00:00",
"ChairMan": "Ole Brumm",
"CEO": "Max Mekker",
"Economy": {
"Year": 2015,
"Turnover": 2134325,
"OperatingProfit": 142345,
"Equity": 548451.0,
"Employees": 32
},
"BisnodeRatingCode": "AAA",
"BisnodeRatingDescription": "Høyeste kredittverdighet",
"CreditLimit": 154000.0,
"PaymentDefaults": "Ingen betalingsanmerkninger er registrert",
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"Report": "Uri to pdf report",
"DetailedInformation": {},
"NumberOfPaymentDefaults": 0
}
},
"Economy": {
"type": "object",
"properties": {
"Year": {
"format": "int32",
"type": "integer"
},
"Turnover": {
"format": "int64",
"type": "integer"
},
"OperatingProfit": {
"format": "int64",
"type": "integer"
},
"Equity": {
"format": "double",
"type": "number"
},
"Employees": {
"format": "int32",
"type": "integer"
}
}
},
"HentForetakResponse": {
"type": "object",
"properties": {
"identifikasjonField": {
"$ref": "#/definitions/Identifikasjon"
},
"navnAdresseField": {
"$ref": "#/definitions/NavnAdresse"
},
"ratingField": {
"$ref": "#/definitions/Rating"
},
"histRatingField": {
"type": "array",
"items": {
"$ref": "#/definitions/HistoriskRating"
}
},
"grunnfaktaField": {
"$ref": "#/definitions/Grunnfakta"
},
"juridiskField": {
"type": "array",
"items": {
"$ref": "#/definitions/Juridisk"
}
},
"vervField": {
"type": "array",
"items": {
"$ref": "#/definitions/Verv"
}
},
"aksjonarField": {
"type": "array",
"items": {
"$ref": "#/definitions/Aksjonar"
}
},
"datterselskapField": {
"type": "array",
"items": {
"$ref": "#/definitions/Datterselskap"
}
},
"okonomiEnkField": {
"type": "array",
"items": {
"$ref": "#/definitions/OkonomiEnk"
}
},
"nokkeltallForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/NokkeltallForetak"
}
},
"nokkeltallBransjeField": {
"type": "array",
"items": {
"$ref": "#/definitions/NokkeltallBransje"
}
},
"nokkeltallKonsernField": {
"type": "array",
"items": {
"$ref": "#/definitions/NokkeltallKonsern"
}
},
"betaSammendragField": {
"$ref": "#/definitions/BetaSammendrag"
},
"betaDetaljerField": {
"type": "array",
"items": {
"$ref": "#/definitions/BetaDetaljer"
}
},
"losoreField": {
"type": "array",
"items": {
"$ref": "#/definitions/Losore"
}
},
"eiendomNorgeField": {
"$ref": "#/definitions/EiendomNorge"
},
"konsernLinkField": {
"type": "array",
"items": {
"$ref": "#/definitions/KonsernLink"
}
},
"scoringField": {
"$ref": "#/definitions/Scoring"
},
"okonomiSammendragForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/OkonomiSammendragForetak"
}
},
"okonomiSammendragKonsernField": {
"type": "array",
"items": {
"$ref": "#/definitions/OkonomiSammendragKonsern"
}
},
"okonomiDetaljerForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/OkonomiDetaljerForetak"
}
},
"okonomiDetaljerKonsernField": {
"type": "array",
"items": {
"$ref": "#/definitions/OkonomiDetaljerKonsern"
}
},
"eiendelerForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/EiendelerForetak"
}
},
"eiendelerKonsernField": {
"type": "array",
"items": {
"$ref": "#/definitions/EiendelerKonsern"
}
},
"gjeldEgenkapitalForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/GjeldEgenkapitalForetak"
}
},
"gjeldEgenkapitalKonsernField": {
"type": "array",
"items": {
"$ref": "#/definitions/GjeldEgenkapitalKonsern"
}
},
"avdelingDataField": {
"$ref": "#/definitions/AvdelingData"
},
"rettighetshavereField": {
"type": "array",
"items": {
"$ref": "#/definitions/Rettighetshavere"
}
},
"eiendomNorgeListeField": {
"type": "array",
"items": {
"$ref": "#/definitions/EiendomNorgeListe"
}
},
"fullmaktForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/FullmaktForetak"
}
},
"meldingerField": {
"type": "array",
"items": {
"$ref": "#/definitions/Meldinger"
}
}
}
},
"Identifikasjon": {
"type": "object",
"properties": {
"orgnrField": {
"format": "int32",
"type": "integer"
},
"dunsnrField": {
"format": "int32",
"type": "integer"
}
}
},
"NavnAdresse": {
"type": "object",
"properties": {
"kodeTypeField": {
"type": "string"
},
"kodeTekstField": {
"type": "string"
},
"navnField": {
"type": "string"
},
"gateAdresseField": {
"type": "string"
},
"gatePostboksField": {
"format": "int32",
"type": "integer"
},
"gatePostnrField": {
"format": "int32",
"type": "integer"
},
"gatePoststedField": {
"type": "string"
},
"postAdresseField": {
"type": "string"
},
"postPostboksField": {
"format": "int32",
"type": "integer"
},
"postPostnrField": {
"format": "int32",
"type": "integer"
},
"postPoststedField": {
"type": "string"
}
}
},
"Rating": {
"type": "object",
"properties": {
"rating1Field": {
"type": "string"
},
"ratingBeskrivelseField": {
"type": "string"
},
"limitField": {
"format": "int32",
"type": "integer"
},
"aktuellHendelseField": {
"type": "string"
},
"delbGrunnfaktaField": {
"type": "string"
},
"delbEierJurdiskField": {
"type": "string"
},
"delbOkonomiField": {
"type": "string"
},
"delbBetalingserfaringField": {
"type": "string"
}
}
},
"HistoriskRating": {
"type": "object",
"properties": {
"endrArField": {
"format": "int32",
"type": "integer"
},
"endrMndField": {
"format": "int32",
"type": "integer"
},
"ratingField": {
"type": "string"
},
"limitField": {
"format": "int32",
"type": "integer"
},
"aktuellHendelseField": {
"type": "string"
},
"regnArField": {
"format": "int32",
"type": "integer"
}
}
},
"Grunnfakta": {
"type": "object",
"properties": {
"selskFormKodeField": {
"type": "string"
},
"selskFormTekstField": {
"type": "string"
},
"etablertArField": {
"format": "int32",
"type": "integer"
},
"etablertArFieldSpecified": {
"type": "boolean"
},
"stiftetDatoField": {
"format": "date-time",
"type": "string"
},
"aksjekapitalField": {
"format": "int64",
"type": "integer"
},
"aksjekapitalStatusField": {
"type": "string"
},
"registrertStedField": {
"type": "string"
},
"registrertDatoField": {
"format": "date-time",
"type": "string"
},
"revisorOrgnrField": {
"format": "int32",
"type": "integer"
},
"revisorNavnField": {
"type": "string"
},
"bankRegnrField": {
"format": "int32",
"type": "integer"
},
"bankNavnField": {
"type": "string"
},
"bransjeDataField": {
"type": "array",
"items": {
"$ref": "#/definitions/BransjeData"
}
},
"ansatteDataField": {
"type": "array",
"items": {
"$ref": "#/definitions/AnsatteData"
}
}
}
},
"Juridisk": {
"type": "object",
"properties": {
"prokuraField": {
"type": "string"
},
"signaturField": {
"type": "string"
},
"eierStrukturField": {
"type": "string"
}
}
},
"Verv": {
"type": "object",
"properties": {
"internRefField": {
"format": "int64",
"type": "integer"
},
"fodtDatoField": {
"format": "date-time",
"type": "string"
},
"fodtDatoFieldSpecified": {
"type": "boolean"
},
"navnField": {
"type": "string"
},
"telefonField": {
"type": "array",
"items": {
"type": "string"
}
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"vervKodeField": {
"type": "string"
},
"vervTekstField": {
"type": "string"
}
}
},
"Aksjonar": {
"type": "object",
"properties": {
"orgnrField": {
"format": "int32",
"type": "integer"
},
"internRefField": {
"format": "int64",
"type": "integer"
},
"fodtDatoField": {
"format": "date-time",
"type": "string"
},
"navnField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"eierandelField": {
"format": "double",
"type": "number"
}
}
},
"Datterselskap": {
"type": "object",
"properties": {
"orgnrField": {
"format": "int64",
"type": "integer"
},
"kodeTypeField": {
"type": "string"
},
"kodeTekstField": {
"type": "string"
},
"navnField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"eierandelField": {
"format": "double",
"type": "number"
}
}
},
"OkonomiEnk": {
"type": "object",
"properties": {
"fodselsdatoEierField": {
"format": "date-time",
"type": "string"
},
"skatteArField": {
"format": "int32",
"type": "integer"
},
"formueField": {
"format": "int64",
"type": "integer"
},
"endringFormueField": {
"format": "double",
"type": "number"
},
"inntektField": {
"format": "int64",
"type": "integer"
},
"endringInntektField": {
"format": "double",
"type": "number"
},
"skattField": {
"format": "int64",
"type": "integer"
},
"skatteKlasseField": {
"type": "string"
},
"skatteKlasseUtlField": {
"type": "string"
},
"kommunenrField": {
"format": "int32",
"type": "integer"
},
"kommuneNavnField": {
"type": "string"
}
}
},
"NokkeltallForetak": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"overskuddsprosentField": {
"format": "double",
"type": "number"
},
"rentedekningsgradField": {
"format": "double",
"type": "number"
},
"totalrentabilitetField": {
"format": "double",
"type": "number"
},
"eKRentabilitetField": {
"format": "double",
"type": "number"
},
"langLagerfinansField": {
"format": "double",
"type": "number"
},
"gjennomsnittLagerField": {
"format": "double",
"type": "number"
},
"egenkapitalAndelField": {
"format": "double",
"type": "number"
},
"tapsbufferField": {
"format": "double",
"type": "number"
},
"fremmedkapitalKostnadField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1Field": {
"format": "double",
"type": "number"
},
"likviditetsgrad2Field": {
"format": "double",
"type": "number"
},
"likviderProsentSalgField": {
"format": "double",
"type": "number"
}
}
},
"NokkeltallBransje": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"overskuddsprosentField": {
"format": "double",
"type": "number"
},
"rentedekningsgradField": {
"format": "double",
"type": "number"
},
"totalrentabilitetField": {
"format": "double",
"type": "number"
},
"eKRentabilitetField": {
"format": "double",
"type": "number"
},
"langLagerfinansField": {
"format": "double",
"type": "number"
},
"gjennomsnittLagerField": {
"format": "double",
"type": "number"
},
"egenkapitalAndelField": {
"format": "double",
"type": "number"
},
"tapsbufferField": {
"format": "double",
"type": "number"
},
"fremmedkapitalKostnadField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1Field": {
"format": "double",
"type": "number"
},
"likviditetsgrad2Field": {
"format": "double",
"type": "number"
},
"likviderProsentSalgField": {
"format": "double",
"type": "number"
}
}
},
"NokkeltallKonsern": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"overskuddsprosentField": {
"format": "double",
"type": "number"
},
"rentedekningsgradField": {
"format": "double",
"type": "number"
},
"totalrentabilitetField": {
"format": "double",
"type": "number"
},
"eKRentabilitetField": {
"format": "double",
"type": "number"
},
"langLagerfinansField": {
"format": "double",
"type": "number"
},
"gjennomsnittLagerField": {
"format": "double",
"type": "number"
},
"egenkapitalAndelField": {
"format": "double",
"type": "number"
},
"tapsbufferField": {
"format": "double",
"type": "number"
},
"fremmedkapitalKostnadField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1Field": {
"format": "double",
"type": "number"
},
"likviditetsgrad2Field": {
"format": "double",
"type": "number"
},
"likviderProsentSalgField": {
"format": "double",
"type": "number"
}
}
},
"BetaSammendrag": {
"type": "object",
"properties": {
"antallInkassoField": {
"format": "int32",
"type": "integer"
},
"ajourDatoInkassoField": {
"format": "date-time",
"type": "string"
},
"antallPanterLosoreField": {
"format": "int32",
"type": "integer"
},
"ajourDatoLosoreField": {
"format": "date-time",
"type": "string"
},
"antallPanterEiendomField": {
"format": "int32",
"type": "integer"
},
"ajourDatoEiendomField": {
"format": "date-time",
"type": "string"
}
}
},
"BetaDetaljer": {
"type": "object",
"properties": {
"registrertDatoField": {
"format": "date-time",
"type": "string"
},
"betaGruppeKodeField": {
"type": "string"
},
"betaGruppeTekstField": {
"type": "string"
},
"betaTypeField": {
"type": "string"
},
"betaTekstField": {
"type": "string"
},
"betaBelopField": {
"format": "int64",
"type": "integer"
},
"kildeKodeField": {
"type": "string"
},
"kildeTekstField": {
"type": "string"
},
"kildeReferansenrField": {
"format": "int64",
"type": "integer"
},
"statusAnmerkningField": {
"type": "string"
},
"statusDatoField": {
"format": "date-time",
"type": "string"
},
"kreditorField": {
"type": "string"
}
}
},
"Losore": {
"type": "object",
"properties": {
"ajourDatoField": {
"format": "date-time",
"type": "string"
},
"spesTekst1Field": {
"type": "string"
},
"spesTekst2Field": {
"type": "string"
},
"spesTekst3Field": {
"type": "string"
}
}
},
"EiendomNorge": {
"type": "object",
"properties": {
"svarEiendomNorgeField": {
"type": "string"
}
}
},
"KonsernLink": {
"type": "object",
"properties": {
"orgnrOversteMorField": {
"format": "int32",
"type": "integer"
},
"orgnrNaermesteMorField": {
"format": "int32",
"type": "integer"
},
"lopenrField": {
"format": "int32",
"type": "integer"
},
"nivaDeltagendeField": {
"format": "int32",
"type": "integer"
},
"landkodeDeltagendeField": {
"type": "string"
},
"orgnrDeltagendeField": {
"format": "int32",
"type": "integer"
},
"navnDeltagendeField": {
"type": "string"
},
"eierandelDeltagendeField": {
"format": "double",
"type": "number"
}
}
},
"Scoring": {
"type": "object",
"properties": {
"beslutningField": {
"type": "string"
},
"arsaksDataField": {
"type": "array",
"items": {
"$ref": "#/definitions/ArsaksData"
}
},
"scoreField": {
"format": "int32",
"type": "integer"
},
"grenseAvslagField": {
"format": "int32",
"type": "integer"
},
"grenseGodkjentField": {
"format": "int32",
"type": "integer"
}
}
},
"OkonomiSammendragForetak": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"totalinntektField": {
"format": "int64",
"type": "integer"
},
"resultatForSkattField": {
"format": "int64",
"type": "integer"
},
"arsResultatField": {
"format": "int64",
"type": "integer"
},
"sumEiendelerField": {
"format": "int64",
"type": "integer"
},
"overskuddsprosentField": {
"format": "double",
"type": "number"
},
"totalrentabilitetField": {
"format": "double",
"type": "number"
},
"egenkapitalandelField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1Field": {
"format": "double",
"type": "number"
},
"likviditetsgrad2Field": {
"format": "double",
"type": "number"
},
"overskuddsprosentBransjeField": {
"format": "double",
"type": "number"
},
"totalrentabilitetBransjeField": {
"format": "double",
"type": "number"
},
"egenkapitalandelBransjeField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1BransjeField": {
"format": "double",
"type": "number"
},
"likviditetsgrad2BransjeField": {
"format": "double",
"type": "number"
}
}
},
"OkonomiSammendragKonsern": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"totalinntektField": {
"format": "int64",
"type": "integer"
},
"resultatForSkattField": {
"format": "int64",
"type": "integer"
},
"arsResultatField": {
"format": "int64",
"type": "integer"
},
"sumEiendelerField": {
"format": "int64",
"type": "integer"
},
"overskuddsprosentField": {
"format": "double",
"type": "number"
},
"totalrentabilitetField": {
"format": "double",
"type": "number"
},
"egenkapitalandelField": {
"format": "double",
"type": "number"
},
"likviditetsgrad1Field": {
"format": "double",
"type": "number"
},
"likviditetsgrad2Field": {
"format": "double",
"type": "number"
}
}
},
"OkonomiDetaljerForetak": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"totalinntektField": {
"format": "int64",
"type": "integer"
},
"salgsinntekterField": {
"format": "int64",
"type": "integer"
},
"annenDriftsinntektField": {
"format": "int64",
"type": "integer"
},
"varekostnadField": {
"format": "int64",
"type": "integer"
},
"beholdningsendringField": {
"format": "int64",
"type": "integer"
},
"lonnskostnadField": {
"format": "int64",
"type": "integer"
},
"avskrivningerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningerField": {
"format": "int64",
"type": "integer"
},
"annenDriftskostnadField": {
"format": "int64",
"type": "integer"
},
"driftsResultatField": {
"format": "int64",
"type": "integer"
},
"inntektInvDatterField": {
"format": "int64",
"type": "integer"
},
"inntektInvKonsernField": {
"format": "int64",
"type": "integer"
},
"inntektInvAnnenField": {
"format": "int64",
"type": "integer"
},
"renteinntektKonsernField": {
"format": "int64",
"type": "integer"
},
"renteinntektAnnenField": {
"format": "int64",
"type": "integer"
},
"finansinntektAnnenField": {
"format": "int64",
"type": "integer"
},
"finansinntektField": {
"format": "int64",
"type": "integer"
},
"verdiendringMarFinOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningMarFinOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningFinAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"rentekostnadKonsernField": {
"format": "int64",
"type": "integer"
},
"annenRentekostnadField": {
"format": "int64",
"type": "integer"
},
"annenFinanskostnadField": {
"format": "int64",
"type": "integer"
},
"finanskostnadField": {
"format": "int64",
"type": "integer"
},
"ordResultatForSkattField": {
"format": "int64",
"type": "integer"
},
"skattOrdResultatField": {
"format": "int64",
"type": "integer"
},
"ordResultatField": {
"format": "int64",
"type": "integer"
},
"ekstraordInntektField": {
"format": "int64",
"type": "integer"
},
"ekstraordKostnadField": {
"format": "int64",
"type": "integer"
},
"skattEkstraordResultatField": {
"format": "int64",
"type": "integer"
},
"sumSkattField": {
"format": "int64",
"type": "integer"
},
"minoritetsInteresserField": {
"format": "int64",
"type": "integer"
},
"arsResultatField": {
"format": "int64",
"type": "integer"
},
"konsernbidragField": {
"format": "int64",
"type": "integer"
},
"utbytteField": {
"format": "int64",
"type": "integer"
},
"tilFondVurdForField": {
"format": "int64",
"type": "integer"
},
"tilAnnenEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"tapKravField": {
"format": "int64",
"type": "integer"
}
}
},
"OkonomiDetaljerKonsern": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"totalinntektField": {
"format": "int64",
"type": "integer"
},
"salgsinntekterField": {
"format": "int64",
"type": "integer"
},
"annenDriftsinntektField": {
"format": "int64",
"type": "integer"
},
"varekostnadField": {
"format": "int64",
"type": "integer"
},
"beholdningsendringField": {
"format": "int64",
"type": "integer"
},
"lonnskostnadField": {
"format": "int64",
"type": "integer"
},
"avskrivningerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningerField": {
"format": "int64",
"type": "integer"
},
"annenDriftskostnadField": {
"format": "int64",
"type": "integer"
},
"driftsResultatField": {
"format": "int64",
"type": "integer"
},
"inntektInvDatterField": {
"format": "int64",
"type": "integer"
},
"inntektInvKonsernField": {
"format": "int64",
"type": "integer"
},
"inntektInvAnnenField": {
"format": "int64",
"type": "integer"
},
"renteinntektKonsernField": {
"format": "int64",
"type": "integer"
},
"renteinntektAnnenField": {
"format": "int64",
"type": "integer"
},
"finansinntektAnnenField": {
"format": "int64",
"type": "integer"
},
"finansinntektField": {
"format": "int64",
"type": "integer"
},
"verdiendringMarFinOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningMarFinOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"nedskrivningFinAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"rentekostnadKonsernField": {
"format": "int64",
"type": "integer"
},
"annenRentekostnadField": {
"format": "int64",
"type": "integer"
},
"annenFinanskostnadField": {
"format": "int64",
"type": "integer"
},
"finanskostnadField": {
"format": "int64",
"type": "integer"
},
"ordResultatForSkattField": {
"format": "int64",
"type": "integer"
},
"skattOrdResultatField": {
"format": "int64",
"type": "integer"
},
"ordResultatField": {
"format": "int64",
"type": "integer"
},
"ekstraordInntektField": {
"format": "int64",
"type": "integer"
},
"ekstraordKostnadField": {
"format": "int64",
"type": "integer"
},
"skattEkstraordResultatField": {
"format": "int64",
"type": "integer"
},
"sumSkattField": {
"format": "int64",
"type": "integer"
},
"minoritetsInteresserField": {
"format": "int64",
"type": "integer"
},
"arsResultatField": {
"format": "int64",
"type": "integer"
},
"konsernbidragField": {
"format": "int64",
"type": "integer"
},
"utbytteField": {
"format": "int64",
"type": "integer"
},
"tilFondVurdForField": {
"format": "int64",
"type": "integer"
},
"tilAnnenEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"tapKravField": {
"format": "int64",
"type": "integer"
}
}
},
"EiendelerForetak": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"sumAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumImmatrielleEiendelerField": {
"format": "int64",
"type": "integer"
},
"forskningUtviklingField": {
"format": "int64",
"type": "integer"
},
"konsesjonerField": {
"format": "int64",
"type": "integer"
},
"utsattSkattefordelField": {
"format": "int64",
"type": "integer"
},
"goodwillField": {
"format": "int64",
"type": "integer"
},
"sumVarigeDriftsmidlerField": {
"format": "int64",
"type": "integer"
},
"fastEiendomField": {
"format": "int64",
"type": "integer"
},
"maskinerAnleggField": {
"format": "int64",
"type": "integer"
},
"skipRiggFlyField": {
"format": "int64",
"type": "integer"
},
"driftsLosoreField": {
"format": "int64",
"type": "integer"
},
"sumFinansielleAnleggsmilderField": {
"format": "int64",
"type": "integer"
},
"investDatterField": {
"format": "int64",
"type": "integer"
},
"investAnnetKonsernField": {
"format": "int64",
"type": "integer"
},
"konsernfordringField": {
"format": "int64",
"type": "integer"
},
"investTilknyttetField": {
"format": "int64",
"type": "integer"
},
"lanTilknyttetField": {
"format": "int64",
"type": "integer"
},
"investAksjerField": {
"format": "int64",
"type": "integer"
},
"obligasjonerField": {
"format": "int64",
"type": "integer"
},
"pensjonsmidlerField": {
"format": "int64",
"type": "integer"
},
"andreAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumVarerField": {
"format": "int64",
"type": "integer"
},
"lagerRavarerField": {
"format": "int64",
"type": "integer"
},
"lagerUferdigeVarerField": {
"format": "int64",
"type": "integer"
},
"lagerFerdigeVarerField": {
"format": "int64",
"type": "integer"
},
"sumFordringerField": {
"format": "int64",
"type": "integer"
},
"fordringerKunderField": {
"format": "int64",
"type": "integer"
},
"fordringerAndreField": {
"format": "int64",
"type": "integer"
},
"fordringerKonsernField": {
"format": "int64",
"type": "integer"
},
"kravInnbetSelskapskapitalField": {
"format": "int64",
"type": "integer"
},
"sumInvesteringerField": {
"format": "int64",
"type": "integer"
},
"aksjerKonsernField": {
"format": "int64",
"type": "integer"
},
"aksjerMarkedField": {
"format": "int64",
"type": "integer"
},
"obligasjonerMarkedField": {
"format": "int64",
"type": "integer"
},
"andreMarkedFinInvField": {
"format": "int64",
"type": "integer"
},
"andreFinInstField": {
"format": "int64",
"type": "integer"
},
"bankinnskuddField": {
"format": "int64",
"type": "integer"
},
"andreOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumEiendelerField": {
"format": "int64",
"type": "integer"
},
"pantstillelserField": {
"format": "int64",
"type": "integer"
}
}
},
"EiendelerKonsern": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"sumAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumImmatrielleEiendelerField": {
"format": "int64",
"type": "integer"
},
"forskningUtviklingField": {
"format": "int64",
"type": "integer"
},
"konsesjonerField": {
"format": "int64",
"type": "integer"
},
"utsattSkattefordelField": {
"format": "int64",
"type": "integer"
},
"goodwillField": {
"format": "int64",
"type": "integer"
},
"sumVarigeDriftsmidlerField": {
"format": "int64",
"type": "integer"
},
"fastEiendomField": {
"format": "int64",
"type": "integer"
},
"maskinerAnleggField": {
"format": "int64",
"type": "integer"
},
"skipRiggFlyField": {
"format": "int64",
"type": "integer"
},
"driftsLosoreField": {
"format": "int64",
"type": "integer"
},
"sumFinansielleAnleggsmilderField": {
"format": "int64",
"type": "integer"
},
"investDatterField": {
"format": "int64",
"type": "integer"
},
"investAnnetKonsernField": {
"format": "int64",
"type": "integer"
},
"konsernfordringField": {
"format": "int64",
"type": "integer"
},
"investTilknyttetField": {
"format": "int64",
"type": "integer"
},
"lanTilknyttetField": {
"format": "int64",
"type": "integer"
},
"investAksjerField": {
"format": "int64",
"type": "integer"
},
"obligasjonerField": {
"format": "int64",
"type": "integer"
},
"pensjonsmidlerField": {
"format": "int64",
"type": "integer"
},
"andreAnleggsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumVarerField": {
"format": "int64",
"type": "integer"
},
"lagerRavarerField": {
"format": "int64",
"type": "integer"
},
"lagerUferdigeVarerField": {
"format": "int64",
"type": "integer"
},
"lagerFerdigeVarerField": {
"format": "int64",
"type": "integer"
},
"sumFordringerField": {
"format": "int64",
"type": "integer"
},
"fordringerKunderField": {
"format": "int64",
"type": "integer"
},
"fordringerAndreField": {
"format": "int64",
"type": "integer"
},
"fordringerKonsernField": {
"format": "int64",
"type": "integer"
},
"kravInnbetSelskapskapitalField": {
"format": "int64",
"type": "integer"
},
"sumInvesteringerField": {
"format": "int64",
"type": "integer"
},
"aksjerKonsernField": {
"format": "int64",
"type": "integer"
},
"aksjerMarkedField": {
"format": "int64",
"type": "integer"
},
"obligasjonerMarkedField": {
"format": "int64",
"type": "integer"
},
"andreMarkedFinInvField": {
"format": "int64",
"type": "integer"
},
"andreFinInstField": {
"format": "int64",
"type": "integer"
},
"bankinnskuddField": {
"format": "int64",
"type": "integer"
},
"andreOmlopsmidlerField": {
"format": "int64",
"type": "integer"
},
"sumEiendelerField": {
"format": "int64",
"type": "integer"
},
"pantstillelserField": {
"format": "int64",
"type": "integer"
}
}
},
"GjeldEgenkapitalForetak": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"sumEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"innskuttEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"selskapskapitalField": {
"format": "int64",
"type": "integer"
},
"egneAksjerField": {
"format": "int64",
"type": "integer"
},
"overkursfondField": {
"format": "int64",
"type": "integer"
},
"opptjentEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"fondForVurdField": {
"format": "int64",
"type": "integer"
},
"annenEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"minoritetsinteresserField": {
"format": "int64",
"type": "integer"
},
"sumGjeldField": {
"format": "int64",
"type": "integer"
},
"avsetningForpliktelserField": {
"format": "int64",
"type": "integer"
},
"pensjonForpliktelserField": {
"format": "int64",
"type": "integer"
},
"utsattSkattField": {
"format": "int64",
"type": "integer"
},
"andreAvsetningerField": {
"format": "int64",
"type": "integer"
},
"sumLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"annenLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"konvertibleLanLangField": {
"format": "int64",
"type": "integer"
},
"obligasjonsLanField": {
"format": "int64",
"type": "integer"
},
"gjeldKredittLangField": {
"format": "int64",
"type": "integer"
},
"gjeldKonsernLangField": {
"format": "int64",
"type": "integer"
},
"ansvarligLanekapitalField": {
"format": "int64",
"type": "integer"
},
"ovrigLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"sumKortsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"konvertibleLanKortField": {
"format": "int64",
"type": "integer"
},
"sertifikatLanField": {
"format": "int64",
"type": "integer"
},
"gjeldKredittKortField": {
"format": "int64",
"type": "integer"
},
"kassakredittField": {
"format": "int64",
"type": "integer"
},
"leverandorGjeldField": {
"format": "int64",
"type": "integer"
},
"betalbarSkattField": {
"format": "int64",
"type": "integer"
},
"skyldOffentligAvgiftField": {
"format": "int64",
"type": "integer"
},
"gjeldKonsernKortField": {
"format": "int64",
"type": "integer"
},
"utbytteField": {
"format": "int64",
"type": "integer"
},
"annenKortsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"sumGjeldEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"kassekredittlimitField": {
"format": "int64",
"type": "integer"
},
"skyldKonsernbidragField": {
"format": "int64",
"type": "integer"
},
"avdragLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
}
}
},
"GjeldEgenkapitalKonsern": {
"type": "object",
"properties": {
"regnskapsAvArField": {
"format": "int32",
"type": "integer"
},
"regnskapsAvMndField": {
"format": "int32",
"type": "integer"
},
"sumEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"innskuttEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"selskapskapitalField": {
"format": "int64",
"type": "integer"
},
"egneAksjerField": {
"format": "int64",
"type": "integer"
},
"overkursfondField": {
"format": "int64",
"type": "integer"
},
"opptjentEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"fondForVurdField": {
"format": "int64",
"type": "integer"
},
"annenEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"minoritetsinteresserField": {
"format": "int64",
"type": "integer"
},
"sumGjeldField": {
"format": "int64",
"type": "integer"
},
"avsetningForpliktelserField": {
"format": "int64",
"type": "integer"
},
"pensjonForpliktelserField": {
"format": "int64",
"type": "integer"
},
"utsattSkattField": {
"format": "int64",
"type": "integer"
},
"andreAvsetningerField": {
"format": "int64",
"type": "integer"
},
"sumLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"annenLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"konvertibleLanLangField": {
"format": "int64",
"type": "integer"
},
"obligasjonsLanField": {
"format": "int64",
"type": "integer"
},
"gjeldKredittLangField": {
"format": "int64",
"type": "integer"
},
"gjeldKonsernLangField": {
"format": "int64",
"type": "integer"
},
"ansvarligLanekapitalField": {
"format": "int64",
"type": "integer"
},
"ovrigLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"sumKortsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"konvertibleLanKortField": {
"format": "int64",
"type": "integer"
},
"sertifikatLanField": {
"format": "int64",
"type": "integer"
},
"gjeldKredittKortField": {
"format": "int64",
"type": "integer"
},
"kassakredittField": {
"format": "int64",
"type": "integer"
},
"leverandorGjeldField": {
"format": "int64",
"type": "integer"
},
"betalbarSkattField": {
"format": "int64",
"type": "integer"
},
"skyldOffentligAvgiftField": {
"format": "int64",
"type": "integer"
},
"gjeldKonsernKortField": {
"format": "int64",
"type": "integer"
},
"utbytteField": {
"format": "int64",
"type": "integer"
},
"annenKortsiktigGjeldField": {
"format": "int64",
"type": "integer"
},
"sumGjeldEgenkapitalField": {
"format": "int64",
"type": "integer"
},
"kassekredittlimitField": {
"format": "int64",
"type": "integer"
},
"skyldKonsernbidragField": {
"format": "int64",
"type": "integer"
},
"avdragLangsiktigGjeldField": {
"format": "int64",
"type": "integer"
}
}
},
"AvdelingData": {
"type": "object",
"properties": {
"antallAnsatteField": {
"format": "int32",
"type": "integer"
},
"antallAnsatteFieldSpecified": {
"type": "boolean"
},
"telefonField": {
"format": "int32",
"type": "integer"
},
"telefonFieldSpecified": {
"type": "boolean"
},
"telefaxField": {
"format": "int32",
"type": "integer"
},
"telefaxFieldSpecified": {
"type": "boolean"
},
"stiftetDatoField": {
"format": "date-time",
"type": "string"
},
"bransjeKodeField": {
"type": "string"
},
"bransjeTekstField": {
"type": "string"
},
"dagligLederField": {
"type": "string"
},
"hovedforetakOrgnrField": {
"format": "int32",
"type": "integer"
},
"hovedforetakOrgnrFieldSpecified": {
"type": "boolean"
},
"hovedforetakDunsnrField": {
"format": "int32",
"type": "integer"
},
"hovedforetakDunsnrFieldSpecified": {
"type": "boolean"
},
"hovedforetakNavnField": {
"type": "string"
}
}
},
"Rettighetshavere": {
"type": "object",
"properties": {
"internreferanseField": {
"format": "int64",
"type": "integer"
},
"fodtDatoField": {
"format": "date-time",
"type": "string"
},
"fodtDatoFieldSpecified": {
"type": "boolean"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"andelField": {
"format": "double",
"type": "number"
},
"indirekteEierField": {
"type": "boolean"
}
}
},
"EiendomNorgeListe": {
"type": "object",
"properties": {
"kommunenrField": {
"format": "int32",
"type": "integer"
},
"kommuneNavnField": {
"type": "string"
},
"gardnrField": {
"format": "int32",
"type": "integer"
},
"bruksnrField": {
"format": "int32",
"type": "integer"
},
"festenrField": {
"format": "int32",
"type": "integer"
},
"seksjonsnrField": {
"format": "int32",
"type": "integer"
},
"typeField": {
"type": "string"
},
"andelField": {
"type": "string"
}
}
},
"FullmaktForetak": {
"type": "object",
"properties": {
"dunsnrField": {
"format": "int32",
"type": "integer"
},
"orgnrField": {
"format": "int32",
"type": "integer"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"statusKodeField": {
"type": "string"
},
"statusTekstField": {
"type": "string"
},
"selskapsformField": {
"type": "string"
},
"prokuraKodeField": {
"type": "string"
},
"prokuraTekstField": {
"type": "string"
},
"signaturKodeField": {
"type": "string"
},
"signaturTekstField": {
"type": "string"
},
"fullmaktPersonField": {
"type": "array",
"items": {
"$ref": "#/definitions/FullmaktPerson"
}
}
}
},
"Meldinger": {
"type": "object",
"properties": {
"meldingsKodeField": {
"format": "int32",
"type": "integer"
},
"meldingsTekstField": {
"type": "string"
}
}
},
"BransjeData": {
"type": "object",
"properties": {
"bransjeKodeField": {
"format": "int32",
"type": "integer"
},
"bransjeTekstField": {
"type": "string"
}
}
},
"AnsatteData": {
"type": "object",
"properties": {
"ansatteArField": {
"format": "int32",
"type": "integer"
},
"ansatteAntallField": {
"format": "int32",
"type": "integer"
}
}
},
"ArsaksData": {
"type": "object",
"properties": {
"arsaksKodeField": {
"type": "string"
},
"arsaksTekstField": {
"type": "string"
}
}
},
"FullmaktPerson": {
"type": "object",
"properties": {
"internreferanseField": {
"format": "int64",
"type": "integer"
},
"fodtDatoField": {
"format": "date-time",
"type": "string"
},
"fodtDatoFieldSpecified": {
"type": "boolean"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"fullmaktTypeKodeField": {
"type": "string"
},
"fullmaktTypeTekstField": {
"type": "string"
},
"fullmaktKodeField": {
"type": "string"
},
"fullmaktTekstField": {
"type": "string"
},
"prioritetField": {
"format": "int32",
"type": "integer"
},
"prioritetFieldSpecified": {
"type": "boolean"
},
"antallField": {
"format": "int32",
"type": "integer"
},
"antallFieldSpecified": {
"type": "boolean"
},
"obligatoriskField": {
"type": "boolean"
},
"obligatoriskFieldSpecified": {
"type": "boolean"
},
"vervField": {
"type": "array",
"items": {
"$ref": "#/definitions/VervData"
}
}
}
},
"VervData": {
"type": "object",
"properties": {
"vervKodeField": {
"type": "string"
},
"vervTekstField": {
"type": "string"
}
}
},
"LeiRecord": {
"type": "object",
"properties": {
"Lei": {
"type": "string"
},
"Entity": {
"$ref": "#/definitions/LeiEntity"
},
"Registration": {
"$ref": "#/definitions/LeiRegistration"
},
"Extension": {
"$ref": "#/definitions/LeiExtension"
}
}
},
"LeiEntity": {
"type": "object",
"properties": {
"HeadquartersAddress": {
"$ref": "#/definitions/LeiEntityAddress"
},
"LegalAddress": {
"$ref": "#/definitions/LeiEntityAddress"
},
"LegalJurisdiction": {
"type": "string"
},
"LegalName": {
"type": "string"
},
"EntityStatus": {
"type": "string"
},
"EntityCategory": {
"type": "string"
},
"LegalForm": {
"$ref": "#/definitions/LeiLegalForm"
},
"RegistrationAuthority": {
"$ref": "#/definitions/LeiRegistrationAuthority"
}
}
},
"LeiRegistration": {
"type": "object",
"properties": {
"InitialRegistrationDate": {
"format": "date-time",
"type": "string"
},
"RegistrationStatus": {
"type": "string"
},
"ValidationSources": {
"type": "string"
},
"LastUpdateDate": {
"format": "date-time",
"type": "string"
},
"NextRenewalDate": {
"format": "date-time",
"type": "string"
},
"ManagingLou": {
"$ref": "#/definitions/ManagingLou"
}
}
},
"LeiExtension": {
"type": "object",
"properties": {
"Normalizations": {
"$ref": "#/definitions/LeiNormalizations"
}
}
},
"LeiEntityAddress": {
"type": "object",
"properties": {
"City": {
"type": "string"
},
"Country": {
"type": "string"
},
"FirstAddressLine": {
"type": "string"
},
"AdditionalAddressLine": {
"type": "array",
"items": {
"type": "string"
}
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
}
}
},
"LeiLegalForm": {
"type": "object",
"properties": {
"OtherLegalForm": {
"type": "string"
},
"EntityLegalFormCode": {
"type": "string"
}
}
},
"LeiRegistrationAuthority": {
"type": "object",
"properties": {
"RegistrationAuthorityId": {
"type": "string"
},
"RegistrationAuthorityEntityId": {
"type": "string"
}
}
},
"ManagingLou": {
"type": "object",
"properties": {
"Lei": {
"type": "string"
},
"Prefix": {
"type": "string"
},
"Name": {
"type": "string"
},
"Website": {
"type": "string"
},
"Operational": {
"type": "string"
},
"EndorsementDate": {
"format": "date-time",
"type": "string"
},
"Sponsor": {
"type": "string"
},
"SponsorCountry": {
"type": "string"
}
}
},
"LeiNormalizations": {
"type": "object",
"properties": {
"LegalName": {
"$ref": "#/definitions/LeiNormalization"
}
}
},
"LeiNormalization": {
"type": "object",
"properties": {
"Cleaned": {
"type": "string"
},
"Normalized": {
"type": "string"
}
}
},
"SearchResult": {
"type": "object",
"properties": {
"next_url": {
"type": "string"
},
"Start": {
"format": "int32",
"type": "integer"
},
"NumFound": {
"format": "int32",
"type": "integer"
},
"Rows": {
"format": "int32",
"type": "integer"
},
"Results": {
"type": "array",
"items": {
"$ref": "#/definitions/LeiRecord"
}
}
}
},
"Person.CreditCheckPersonResponse": {
"type": "object",
"properties": {
"RequestId": {
"type": "string"
},
"Report": {
"type": "string"
},
"Name": {
"type": "string"
},
"Address": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Score": {
"format": "int32",
"type": "integer"
},
"ScoreDecision": {
"type": "string"
},
"DateOfBirth": {
"type": "string"
},
"Age": {
"format": "int32",
"type": "integer"
},
"Gender": {
"type": "string"
},
"NumberOfPaymentDefaults": {
"format": "int32",
"type": "integer"
},
"PaymentDefaultsAmount": {
"format": "double",
"type": "number"
},
"IncomeAndFortune": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.Economy"
}
},
"DetailedInformation": {
"$ref": "#/definitions/Person.HentPersonResponse"
}
},
"example": {
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"Report": "Uri for pdf report",
"Name": "TEST TESTESEN",
"Address": "TESTVEIEN 5",
"City": "BERGEN",
"PostalCode": "5551",
"Score": 44,
"ScoreDecision": "Approved",
"DateOfBirth": "31.06.1990",
"Age": 26,
"Gender": "MANN",
"NumberOfPaymentDefaults": 1,
"PaymentDefaultsAmount": 5862.0,
"IncomeAndFortune": [
{
"Year": 2015,
"NetIncome": 511111.0,
"IncomeChange": 0.0,
"Fortune": 21345.0,
"AssessedTax": 111111.0,
"TaxClass": "1E",
"Municipal": "OSLO",
"MunicipalNumber": "301"
},
{
"Year": 2014,
"NetIncome": 511111.0,
"IncomeChange": 360.0,
"Fortune": 213345.0,
"AssessedTax": 111111.0,
"TaxClass": "1E",
"Municipal": "OSLO",
"MunicipalNumber": "301"
},
{
"Year": 2013,
"NetIncome": 511111.0,
"IncomeChange": 0.0,
"Fortune": 0.0,
"AssessedTax": 11111.0,
"TaxClass": "1E",
"Municipal": "BERGEN",
"MunicipalNumber": "222"
}
],
"DetailedInformation": {}
}
},
"Person.Economy": {
"type": "object",
"properties": {
"Year": {
"format": "int32",
"type": "integer"
},
"NetIncome": {
"format": "double",
"type": "number"
},
"IncomeChange": {
"format": "double",
"type": "number"
},
"Fortune": {
"format": "double",
"type": "number"
},
"AssessedTax": {
"format": "double",
"type": "number"
},
"TaxClass": {
"type": "string"
},
"Municipal": {
"type": "string"
},
"MunicipalNumber": {
"type": "string"
}
}
},
"Person.HentPersonResponse": {
"type": "object",
"properties": {
"identifikasjonField": {
"$ref": "#/definitions/Person.Identifikasjon"
},
"navnAdresseField": {
"$ref": "#/definitions/Person.NavnAdresse"
},
"scoringField": {
"$ref": "#/definitions/Person.Scoring"
},
"delomraderField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.Delomrader"
}
},
"betaSammendragField": {
"$ref": "#/definitions/Person.BetaSammendrag"
},
"betaDetaljerField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.BetaDetaljer"
}
},
"ligningField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.Ligning"
}
},
"disponibelInntektField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.DisponibelInntekt"
}
},
"naringsInteresserField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.NaringsInteresser"
}
},
"eiendomNorgeField": {
"$ref": "#/definitions/Person.EiendomNorge"
},
"eiendomListeField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.EiendomListe"
}
},
"losoreField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.Losore"
}
},
"tidligereNavnAdresseField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.TidligereNavnAdresse"
}
},
"fullmaktForetakField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.FullmaktForetak"
}
},
"meldingerField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.Meldinger"
}
}
}
},
"Person.Identifikasjon": {
"type": "object",
"properties": {
"internrefField": {
"format": "int64",
"type": "integer"
}
}
},
"Person.NavnAdresse": {
"type": "object",
"properties": {
"statusField": {
"type": "string"
},
"statusDatoField": {
"format": "date-time",
"type": "string"
},
"fodselsdatoField": {
"format": "date-time",
"type": "string"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"type": "string"
},
"poststedField": {
"type": "string"
},
"kommuneField": {
"type": "string"
},
"fylkeField": {
"type": "string"
},
"alderField": {
"format": "int32",
"type": "integer"
},
"kjonnField": {
"type": "string"
},
"telefonField": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Person.Scoring": {
"type": "object",
"properties": {
"beslutningField": {
"type": "string"
},
"arsaksDataField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.ArsaksData"
}
},
"scoreField": {
"format": "int32",
"type": "integer"
},
"grenseAvslagField": {
"format": "int32",
"type": "integer"
},
"grenseGodkjentField": {
"format": "int32",
"type": "integer"
}
}
},
"Person.Delomrader": {
"type": "object",
"properties": {
"delomradeKodeField": {
"type": "string"
},
"delomradeTekstField": {
"type": "string"
},
"bedommelseKodeField": {
"type": "string"
},
"bedommelseTekstField": {
"type": "string"
}
}
},
"Person.BetaSammendrag": {
"type": "object",
"properties": {
"antallInkassoField": {
"format": "int32",
"type": "integer"
},
"ajourDatoInkassoField": {
"format": "date-time",
"type": "string"
},
"antallPanterLosoreField": {
"format": "int32",
"type": "integer"
},
"ajourDatoLosoreField": {
"format": "date-time",
"type": "string"
},
"antallPanterEiendomField": {
"format": "int32",
"type": "integer"
},
"ajourDatoEiendomField": {
"format": "date-time",
"type": "string"
}
}
},
"Person.BetaDetaljer": {
"type": "object",
"properties": {
"registrertDatoField": {
"format": "date-time",
"type": "string"
},
"betaGruppeKodeField": {
"type": "string"
},
"betaGruppeTekstField": {
"type": "string"
},
"betaTypeField": {
"type": "string"
},
"betaTekstField": {
"type": "string"
},
"betaBelopField": {
"format": "int64",
"type": "integer"
},
"kildeKodeField": {
"type": "string"
},
"kildeTekstField": {
"type": "string"
},
"kildeReferansenrField": {
"format": "int64",
"type": "integer"
},
"statusAnmerkningField": {
"type": "string"
},
"statusDatoField": {
"format": "date-time",
"type": "string"
},
"kreditorField": {
"type": "string"
}
}
},
"Person.Ligning": {
"type": "object",
"properties": {
"skatteArField": {
"format": "int32",
"type": "integer"
},
"formueField": {
"format": "int64",
"type": "integer"
},
"endringFormueField": {
"format": "double",
"type": "number"
},
"inntektField": {
"format": "int64",
"type": "integer"
},
"endringInntektField": {
"format": "double",
"type": "number"
},
"skattField": {
"format": "int64",
"type": "integer"
},
"skatteKlasseField": {
"type": "string"
},
"skatteKlasseUtlField": {
"type": "string"
},
"kommunenrField": {
"type": "string"
},
"kommuneNavnField": {
"type": "string"
},
"bruttoInntektField": {
"format": "int64",
"type": "integer"
},
"gjeldsgrad1Field": {
"format": "double",
"type": "number"
},
"gjeldsgrad2Field": {
"format": "double",
"type": "number"
}
}
},
"Person.DisponibelInntekt": {
"type": "object",
"properties": {
"kodeField": {
"format": "int32",
"type": "integer"
},
"beskrivelseField": {
"type": "string"
}
}
},
"Person.NaringsInteresser": {
"type": "object",
"properties": {
"orgnrField": {
"format": "int32",
"type": "integer"
},
"statusKodeField": {
"type": "string"
},
"statusTekstField": {
"type": "string"
},
"statusDatoField": {
"format": "date-time",
"type": "string"
},
"navnField": {
"type": "string"
},
"selskFormField": {
"type": "string"
},
"rolleField": {
"type": "string"
},
"eierandelField": {
"format": "double",
"type": "number"
},
"vervKodeField": {
"type": "string"
},
"vervTekstField": {
"type": "string"
}
}
},
"Person.EiendomNorge": {
"type": "object",
"properties": {
"svarEiendomNorgeField": {
"type": "string"
}
}
},
"Person.EiendomListe": {
"type": "object",
"properties": {
"kommunenrField": {
"type": "string"
},
"kommuneNavnField": {
"type": "string"
},
"gardnrField": {
"format": "int32",
"type": "integer"
},
"bruksnrField": {
"format": "int32",
"type": "integer"
},
"festenrField": {
"format": "int32",
"type": "integer"
},
"seksjonsnrField": {
"format": "int32",
"type": "integer"
},
"typeField": {
"type": "string"
},
"andelField": {
"type": "string"
}
}
},
"Person.Losore": {
"type": "object",
"properties": {
"ajourDatoField": {
"format": "date-time",
"type": "string"
},
"spesTekst1Field": {
"type": "string"
},
"spesTekst2Field": {
"type": "string"
},
"spesTekst3Field": {
"type": "string"
}
}
},
"Person.TidligereNavnAdresse": {
"type": "object",
"properties": {
"tidligereNavnAdresse1Field": {
"type": "string"
},
"endringsDatoField": {
"format": "date-time",
"type": "string"
},
"endringsTypeField": {
"type": "string"
},
"tidligerePostAdresseField": {
"type": "string"
}
}
},
"Person.FullmaktForetak": {
"type": "object",
"properties": {
"dunsnrField": {
"format": "int32",
"type": "integer"
},
"orgnrField": {
"format": "int32",
"type": "integer"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"statusKodeField": {
"type": "string"
},
"statusTekstField": {
"type": "string"
},
"selskapsformField": {
"type": "string"
},
"prokuraKodeField": {
"type": "string"
},
"prokuraTekstField": {
"type": "string"
},
"signaturKodeField": {
"type": "string"
},
"signaturTekstField": {
"type": "string"
},
"fullmaktPersonField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.FullmaktPerson"
}
}
}
},
"Person.Meldinger": {
"type": "object",
"properties": {
"meldingsKodeField": {
"format": "int32",
"type": "integer"
},
"meldingsTekstField": {
"type": "string"
}
}
},
"Person.ArsaksData": {
"type": "object",
"properties": {
"arsaksKodeField": {
"type": "string"
},
"arsaksTekstField": {
"type": "string"
}
}
},
"Person.FullmaktPerson": {
"type": "object",
"properties": {
"internreferanseField": {
"format": "int64",
"type": "integer"
},
"fodtDatoField": {
"format": "date-time",
"type": "string"
},
"fodtDatoFieldSpecified": {
"type": "boolean"
},
"navnField": {
"type": "string"
},
"adresseField": {
"type": "string"
},
"postnrField": {
"format": "int32",
"type": "integer"
},
"poststedField": {
"type": "string"
},
"fullmaktTypeKodeField": {
"type": "string"
},
"fullmaktTypeTekstField": {
"type": "string"
},
"fullmaktKodeField": {
"type": "string"
},
"fullmaktTekstField": {
"type": "string"
},
"prioritetField": {
"format": "int32",
"type": "integer"
},
"prioritetFieldSpecified": {
"type": "boolean"
},
"antallField": {
"format": "int32",
"type": "integer"
},
"antallFieldSpecified": {
"type": "boolean"
},
"obligatoriskField": {
"type": "boolean"
},
"obligatoriskFieldSpecified": {
"type": "boolean"
},
"vervField": {
"type": "array",
"items": {
"$ref": "#/definitions/Person.VervData"
}
}
}
},
"Person.VervData": {
"type": "object",
"properties": {
"vervKodeField": {
"type": "string"
},
"vervTekstField": {
"type": "string"
}
}
},
"Person.PersonInformation": {
"type": "object",
"properties": {
"Firstname": {
"type": "string"
},
"Middlename": {
"type": "string"
},
"Lastname": {
"type": "string"
},
"DateOfBirth": {
"type": "string"
},
"Address": {
"type": "string"
},
"ZipCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Gender": {
"type": "string"
},
"RawJson": {
"type": "string"
},
"RequestId": {
"type": "string"
},
"Dead": {
"format": "date-time",
"type": "string"
},
"Source": {
"type": "string"
}
},
"example": {
"Firstname": "Kari",
"Middlename": "",
"Lastname": "Normann",
"DateOfBirth": "22.08.88",
"Address": "Testveien 123",
"ZipCode": "5454",
"City": "Bergen",
"Mobile": "11111111",
"Phone": "12345657",
"Gender": "Female",
"RawJson": "This json-string contains all the raw data received from matchit",
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
},
"Person.OfficialPersonRegistryResponse": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"MiddleName": {
"type": "string"
},
"Fullname": {
"type": "string"
},
"Address": {
"type": "string"
},
"Address2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Gender": {
"type": "string"
},
"RawJson": {
"type": "string"
},
"RequestId": {
"type": "string"
}
},
"example": {
"FirstName": "EDVARD",
"LastName": "POST",
"MiddleName": "FOE",
"Fullname": "POST EDVARD FOE",
"Address": "KARL ALFRED FOES GATE 113 A",
"Address2": "POSTBOKS 54321 SENTRUMSAKTIGJA",
"City": "GALTERUD",
"PostalCode": "2223",
"Gender": "Male",
"RawJson": "This json contains all information from the infotorg response",
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3"
}
},
"SignatureRights": {
"type": "object",
"properties": {
"MvaNumber": {
"format": "int32",
"type": "integer"
},
"Name": {
"type": "string"
},
"Signatur": {
"$ref": "#/definitions/SignatureObject"
},
"Prokura": {
"$ref": "#/definitions/SignatureObject"
},
"Report": {
"type": "string"
},
"RequestId": {
"type": "string"
},
"ReportId": {
"type": "string"
}
},
"example": {
"MvaNumber": 123456789,
"Name": "Kopp Vedkløyveri AS",
"Signatur": {
"RequirementsDescription": "Styreleder pluss 2 styremedlemmer",
"Required": {
"List": [
{
"Name": "Test Person",
"DateOfBirth": "250584"
}
]
},
"Others": {
"RequiredNumberOfOthers": 2,
"List": [
{
"Name": "Kari Normann",
"DateOfBirth": "080890"
},
{
"Name": "Ola Normann",
"DateOfBirth": "211090"
},
{
"Name": "Test Testesen",
"DateOfBirth": "201090"
}
]
}
},
"Prokura": {
"RequirementsDescription": "Daglig leder alene",
"Required": {
"List": [
{
"Name": "Edvard Post",
"DateOfBirth": "060657"
}
]
},
"Others": {
"RequiredNumberOfOthers": 0,
"List": []
}
}
}
},
"SignatureObject": {
"type": "object",
"properties": {
"RequirementsDescription": {
"type": "string"
},
"Required": {
"$ref": "#/definitions/RequiredSignatures"
},
"Others": {
"$ref": "#/definitions/OtherSignatures"
}
}
},
"RequiredSignatures": {
"type": "object",
"properties": {
"List": {
"type": "array",
"items": {
"$ref": "#/definitions/Signature"
}
}
}
},
"OtherSignatures": {
"type": "object",
"properties": {
"RequiredNumberOfOthers": {
"format": "int32",
"type": "integer"
},
"List": {
"type": "array",
"items": {
"$ref": "#/definitions/Signature"
}
}
}
},
"Signature": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"DateOfBirth": {
"type": "string"
},
"Role": {
"type": "string"
}
}
},
"SignatureCheckRequest": {
"type": "object",
"properties": {
"Organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/OrganizationRequest"
}
}
},
"example": {
"Organizations": [
{
"OrgNumber": "123456789",
"Prokura": true,
"Signature": false,
"Signatures": [
{
"Name": "Firstname Lastname",
"DateOfBirth": "291144"
},
{
"Name": "Firstname Middlename Lastname",
"DateOfBirth": "230176"
}
]
}
]
}
},
"OrganizationRequest": {
"type": "object",
"properties": {
"OrgNumber": {
"type": "string"
},
"Prokura": {
"type": "boolean"
},
"Signature": {
"type": "boolean"
},
"Signatures": {
"type": "array",
"items": {
"$ref": "#/definitions/CheckSignature"
}
}
}
},
"CheckSignature": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"DateOfBirth": {
"type": "string"
}
}
},
"SignatureStatusResponse": {
"type": "object",
"properties": {
"RequestId": {
"type": "string"
},
"Organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/OrganizationResponse"
}
}
},
"example": {
"RequestId": "be6b0d54-0cf2-41a2-a56d-78718aa01bb3",
"Organizations": [
{
"MvaNumber": 123456789,
"Prokura": "valid",
"Signature": "notchecked",
"Report": "Uri to report in pdf format"
},
{
"MvaNumber": 987654321,
"Prokura": "valid",
"Signature": "notvalid",
"Report": "Uri to report in pdf format"
}
]
}
},
"OrganizationResponse": {
"type": "object",
"properties": {
"MvaNumber": {
"format": "int32",
"type": "integer"
},
"Prokura": {
"type": "string"
},
"Signature": {
"type": "string"
},
"Report": {
"type": "string"
}
}
},
"RecipientResponse": {
"description": "Recipient of the secure share",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Unique identifier",
"type": "string"
},
"firstName": {
"description": "Recipients first name",
"type": "string"
},
"lastName": {
"description": "Recipients last name",
"type": "string"
},
"email": {
"description": "Recipients email",
"type": "string"
},
"expires": {
"format": "date-time",
"description": "How long the secure share will be available for the recipient",
"type": "string"
},
"mobile": {
"$ref": "#/definitions/shareMobile"
},
"content": {
"description": "List of uploads the recipient can access",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/UploadResponse"
}
},
"externalId": {
"description": "Creators id",
"type": "string"
},
"url": {
"description": "The url sent to the recipient",
"type": "string"
},
"authentication": {
"description": "List of valid authentication methods and corresponding info like ssn",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/shareAuthentication"
}
},
"oneTimeLogin": {
"description": "Restrict the recipient to login once",
"type": "boolean"
},
"notification": {
"$ref": "#/definitions/shareNotification",
"description": "How we should notify the recipient"
}
}
},
"shareMobile": {
"description": "shareMobile",
"type": "object",
"properties": {
"countryCode": {
"description": "Country code, no need to add +",
"type": "string"
},
"number": {
"description": "Valid phonenumber",
"type": "string"
}
}
},
"UploadResponse": {
"description": "Upload information",
"type": "object",
"properties": {
"name": {
"description": "Name of content",
"type": "string"
},
"opened": {
"description": "If the recipient has opened the file",
"type": "boolean"
},
"openedDate": {
"format": "date-time",
"description": "When the file was last opened",
"type": "string"
}
}
},
"shareAuthentication": {
"type": "object",
"properties": {
"identityProvider": {
"description": "The identityprovider type (Norwegian BankID, buypass etc)",
"enum": [
"NoBankIdMobile",
"NoBankIdWeb",
"SweBankId",
"SweBankIdMobile",
"NoBuypass",
"DaNemId",
"FiTupas",
"SmsOtp"
],
"type": "string"
},
"identityProviderUniqueId": {
"description": "The uniqueID from the e-ID, this ID is unique for the user and is the same every time the user logs on. This is not a sensitiv ID and your could store this to identify the user in you database. Remark: The Swedish BankID do not have an unique ID.",
"type": "string"
},
"ssn": {
"description": "Social security number",
"type": "string"
},
"dateOfBirth": {
"description": "The users date of birth format ddMMyy",
"type": "string"
}
}
},
"shareNotification": {
"description": "Options for notification",
"type": "object",
"properties": {
"setup": {
"$ref": "#/definitions/NotificationSetup"
},
"language": {
"description": "Language for the notifications\r\nDefaults to Norwegian",
"enum": [
"No",
"En"
],
"type": "string"
},
"customEmailTexts": {
"description": "Custom texts in email notifcations",
"type": "object",
"properties": {
"Start": {
"type": "string"
}
}
}
}
},
"NotificationSetup": {
"description": "Setup of notifications",
"type": "object",
"properties": {
"request": {
"description": "What form of notification for creation. \r\nDefaults to off",
"enum": [
"Off",
"SendSms",
"SendEmail",
"SendBoth"
],
"type": "string"
},
"reminder": {
"description": "What form of notification for reminder. \r\nDefaults to off",
"enum": [
"Off",
"SendSms",
"SendEmail",
"SendBoth"
],
"type": "string"
}
}
},
"UpdateRecipent": {
"type": "object",
"properties": {
"firstName": {
"description": "Recipients first name",
"maxLength": 75,
"minLength": 3,
"type": "string"
},
"lastName": {
"description": "Recipients last name",
"maxLength": 75,
"minLength": 3,
"type": "string"
},
"email": {
"description": "Recipients email",
"type": "string"
},
"expires": {
"format": "date",
"description": "How long the fileshare should be available",
"type": "string"
},
"mobile": {
"$ref": "#/definitions/shareMobile"
},
"uploads": {
"description": "List of content identificators the recipient can access",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"authentication": {
"description": "Auth providers",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/shareAuthentication"
}
},
"notification": {
"$ref": "#/definitions/shareNotification"
},
"externalId": {
"description": "Creators id",
"type": "string"
},
"oneTimeLogin": {
"description": "Restrict the recipient to login once",
"type": "boolean"
}
},
"example": {
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-04-03T08:00:55.8445863+00:00",
"mobile": {},
"uploads": [
"1234"
],
"authentication": [
{
"identityProvider": "NoBankIdWeb",
"identityProviderUniqueId": "9578-600-4-257409",
"dateOfBirth": "010188"
}
],
"notification": {
"setup": {
"request": "SendBoth",
"reminder": "SendEmail"
},
"language": "En"
},
"externalId": "external",
"oneTimeLogin": false
}
},
"ShareResponse": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Unique identifier",
"type": "string"
},
"information": {
"$ref": "#/definitions/Information"
},
"recipients": {
"description": "List of recipients",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/RecipientResponse"
}
},
"content": {
"description": "List of content",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/ServerUpload"
}
},
"uploadedDocuments": {
"format": "int32",
"description": "Number of documents uploaded",
"type": "integer"
},
"created": {
"format": "date-time",
"description": "Creation time",
"type": "string"
},
"done": {
"description": "All content opened or expired",
"type": "boolean"
},
"deleted": {
"description": "Deleted by creator",
"type": "boolean"
},
"contactDetails": {
"$ref": "#/definitions/shareContactDetails"
},
"senders": {
"description": "Senders",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Sender"
}
},
"advanced": {
"$ref": "#/definitions/shareAdvanced",
"description": "Optional settings for advanced configuration"
}
}
},
"Information": {
"description": "Information about the secure share",
"type": "object",
"properties": {
"title": {
"description": "Title of the secure share, will be presented to the recipient",
"maxLength": 50,
"minLength": 3,
"type": "string"
},
"description": {
"description": "Descripition of secure share, will be present in standard notificaitons",
"maxLength": 250,
"minLength": 3,
"type": "string"
},
"externalId": {
"description": "Creators id for the secure share",
"type": "string"
},
"departmentId": {
"description": "Department id",
"type": "string"
},
"confidentialInfo": {
"description": "Information not avaliable before the recipient has authenticated itself",
"type": "string"
}
}
},
"ServerUpload": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"type": {
"enum": [
"file"
],
"type": "string"
}
}
},
"shareContactDetails": {
"description": "Contact details for creator of secure share, will be presented to recipient.",
"required": [
"email"
],
"type": "object",
"properties": {
"name": {
"description": "Name to present to the recipient",
"type": "string"
},
"phone": {
"description": "Phonenumber recipient can contact",
"type": "string"
},
"email": {
"description": "Email recipient can contact",
"type": "string"
},
"url": {
"description": "Web page the recipient can visit",
"type": "string"
}
}
},
"Sender": {
"type": "object",
"properties": {
"email": {
"description": "Email",
"type": "string"
},
"mobile": {
"$ref": "#/definitions/shareMobile"
},
"notificationType": {
"description": "What kind of notifications does this sender want to receive, defaults to off",
"enum": [
"Off",
"SendSms",
"SendEmail",
"SendBoth"
],
"type": "string"
},
"notificationEvent": {
"description": "At what events does this sender want to be notified. Defaults to none",
"enum": [
"None",
"Single",
"Both",
"All"
],
"type": "string"
}
}
},
"shareAdvanced": {
"description": "Optional settings for advanced configuration",
"type": "object",
"properties": {
"tags": {
"description": "A list of tags to add to the document. These tags can be used to query for\r\nshare data and will also be added to all events that are triggered for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UpdateShareRequest": {
"type": "object",
"properties": {
"title": {
"description": "Title of the secure share, will be presented to the recipient",
"type": "string"
},
"description": {
"description": "Descripition of secure share, will be present in standard notificaitons",
"type": "string"
},
"contactDetails": {
"$ref": "#/definitions/shareContactDetails"
}
},
"example": {
"title": "Updated title",
"description": "Updated description",
"contactDetails": {
"name": "Idfy.io",
"phone": "+4712345678",
"email": "support@idfy.io",
"url": "https://idfy.io"
}
}
},
"Recipient": {
"required": [
"firstName",
"lastName",
"email",
"expires"
],
"type": "object",
"properties": {
"firstName": {
"description": "Recipients first name",
"maxLength": 75,
"minLength": 3,
"type": "string"
},
"lastName": {
"description": "Recipients last name",
"maxLength": 75,
"minLength": 3,
"type": "string"
},
"email": {
"description": "Recipients email",
"type": "string"
},
"expires": {
"format": "date",
"description": "How long the fileshare should be available. Must be after the moment its created, and cant be avaliable longer than 90 days.\r\nHas to be in the ISO 8601 format",
"type": "string"
},
"mobile": {
"$ref": "#/definitions/shareMobile"
},
"content": {
"description": "List of content identificators the recipient can access. NOTE: If no uploads are specified, the recipient will be granted access to all files.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"authentication": {
"description": "Auth providers",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/shareAuthentication"
}
},
"notification": {
"$ref": "#/definitions/shareNotification",
"description": "How to contact the recipient"
},
"externalId": {
"description": "Creators id",
"type": "string"
},
"oneTimeLogin": {
"description": "Restrict the recipient to login once",
"type": "boolean"
}
},
"example": {
"firstName": "Tony",
"lastName": "Stark",
"email": "support@idfy.io",
"expires": "2020-04-03T08:00:55.8779249+00:00",
"mobile": {},
"content": [
"1234"
],
"authentication": [
{
"identityProvider": "NoBankIdMobile",
"identityProviderUniqueId": "9578-600-4-257409",
"dateOfBirth": "010188"
}
],
"notification": {
"setup": {
"request": "SendBoth",
"reminder": "SendEmail"
},
"language": "En"
},
"externalId": "external",
"oneTimeLogin": false
}
},
"CreateShareRequest": {
"required": [
"content",
"recipients",
"contactDetails"
],
"type": "object",
"properties": {
"information": {
"$ref": "#/definitions/Information"
},
"content": {
"description": "List of unique things to share",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Upload"
}
},
"recipients": {
"description": "List of the recipients of this secure share",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Recipient"
}
},
"contactDetails": {
"$ref": "#/definitions/shareContactDetails"
},
"senders": {
"description": "List of people sending this share.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Sender"
}
},
"advanced": {
"$ref": "#/definitions/shareAdvanced",
"description": "Optional settings for advanced configuration."
}
},
"example": {
"information": {
"title": "Title",
"description": "Description of the filshare"
},
"content": [
{
"id": "1",
"name": "testing1.pdf",
"type": "file"
}
],
"recipients": [
{
"firstName": "Tony",
"lastName": "Stark",
"email": "customeremail@idfy.io",
"expires": "2020-04-03T08:00:55.886788+00:00",
"mobile": {
"countryCode": "47",
"number": "12345678"
},
"content": [
"1"
],
"authentication": [],
"notification": {
"setup": {
"request": "SendBoth",
"reminder": "Off"
},
"language": "No"
},
"oneTimeLogin": false
}
]
}
},
"Upload": {
"type": "object",
"properties": {
"id": {
"description": "Unique id for share",
"type": "string"
},
"name": {
"description": "Name of upload, will be presented to the user",
"type": "string"
},
"type": {
"description": "What kind of content is it. Defaults to file",
"enum": [
"file"
],
"type": "string"
}
}
},
"EventDto": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"type": {
"type": "string"
},
"payload": {
"type": "object"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"accountId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"EventTypeInfo": {
"type": "object",
"properties": {
"id": {
"description": "Event type",
"enum": [
"document_before_deleted",
"document_canceled",
"document_created",
"document_deleted",
"document_expired",
"document_email_opened",
"document_form_partially_signed",
"document_form_signed",
"document_link_opened",
"document_packaged",
"document_partially_signed",
"document_read",
"document_signed"
],
"type": "string"
},
"name": {
"description": "Display name of the event",
"type": "string"
},
"description": {
"description": "Description of the event",
"type": "string"
}
}
},
"MockEventRequest": {
"required": [
"eventType"
],
"type": "object",
"properties": {
"eventType": {
"description": "Event type to mock",
"type": "string"
}
}
},
"WebhookDto": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"description": "The webhooks unique identifier.",
"type": "integer"
},
"name": {
"description": "Display name of the webhook.",
"type": "string"
},
"active": {
"description": "Determines if the webhook is active.",
"type": "boolean"
},
"events": {
"description": "A list of events that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/definitions/WebhookConfig"
},
"createdAt": {
"format": "date-time",
"description": "Time at which the webhook was created.",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"description": "Time at which the webhook was last updated.",
"type": "string"
},
"lastResponse": {
"$ref": "#/definitions/WebhookResponse"
},
"tags": {
"description": "A list of event tags that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"WebhookConfig": {
"type": "object",
"properties": {
"url": {
"description": "The URL to which the payloads will be delivered.",
"type": "string"
},
"secret": {
"description": "Optional secret used to compute a HMAC hex digest of the payload, \r\nwhich is passed with the HTTP request as an ``X-Idfy-Signature`` header.",
"type": "string"
},
"deliveryLogging": {
"description": "Determines whether to log webhook delivery attempts. Defaults to `never`.",
"enum": [
"never",
"failed",
"always"
],
"type": "string"
}
}
},
"WebhookResponse": {
"type": "object",
"properties": {
"code": {
"format": "int32",
"description": "The status code returned by the webhook endpoint on last delivery attempt.",
"type": "integer"
},
"message": {
"description": "The message returned by the webhook endpoint on last delivery attempt.",
"type": "string"
},
"timestamp": {
"format": "date-time",
"description": "Time at which the last delivery attempt was made.",
"type": "string"
}
}
},
"WebhookUpdateDto": {
"type": "object",
"properties": {
"name": {
"description": "Display name of the webhook.",
"type": "string"
},
"active": {
"description": "Determines whether the webhook is active or not.",
"type": "boolean"
},
"events": {
"description": "A list of events that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/definitions/WebhookConfig"
},
"tags": {
"description": "An optional list of event tags that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"WebhookCreateDto": {
"required": [
"name",
"active",
"events",
"config"
],
"type": "object",
"properties": {
"name": {
"description": "Display name of the webhook.",
"type": "string"
},
"active": {
"description": "Determines whether the webhook is active or not.",
"type": "boolean"
},
"events": {
"description": "A list of events that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
},
"config": {
"$ref": "#/definitions/WebhookCreateConfig"
},
"tags": {
"description": "An optional list of event tags that the webhook triggers for.",
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"name": "My webhook",
"active": true,
"events": [
"document_created",
"document_signed"
],
"config": {
"url": "https://example.com/webhook-endpoint",
"secret": "secret",
"deliveryLogging": "failed"
}
}
},
"WebhookCreateConfig": {
"required": [
"url"
],
"type": "object",
"properties": {
"url": {
"description": "The URL to which the payloads will be delivered.",
"type": "string"
},
"secret": {
"description": "Optional secret used to compute a HMAC hex digest of the payload, \r\nwhich is passed with the HTTP request as an ``X-Idfy-Signature`` header.",
"type": "string"
},
"deliveryLogging": {
"description": "Determines whether to log webhook delivery attempts. Defaults to `never`.",
"enum": [
"never",
"failed",
"always"
],
"type": "string"
}
}
},
"WebhookDeliveryDto": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The webhooks unique identifier.",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"webhookId": {
"format": "int32",
"type": "integer"
},
"eventId": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"url": {
"type": "string"
},
"elapsedMs": {
"format": "int64",
"type": "integer"
},
"requestHeaders": {
"type": "object"
},
"requestBody": {
"type": "object"
},
"responseHeaders": {
"type": "object"
},
"responseBody": {
"type": "object"
},
"responseStatusCode": {
"format": "int32",
"type": "integer"
},
"responseMessage": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"CreateDepositResponse": {
"required": [
"externalId",
"rentObject",
"contactDetails"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The deposit's unique identifier.",
"type": "string"
},
"documentId": {
"format": "uuid",
"description": "The document's unique identifier.",
"type": "string"
},
"tenants": {
"description": "Array of tenants for the deposit",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/TenantsResponse"
}
},
"landlord": {
"$ref": "#/definitions/LandlordResponse"
},
"created": {
"format": "date-time",
"description": "Date of creation",
"type": "string"
},
"contract": {
"$ref": "#/definitions/ContractResponse"
},
"status": {
"$ref": "#/definitions/depositStatus"
},
"externalId": {
"description": "Your reference for the contract.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"rentObject": {
"$ref": "#/definitions/RentObjectRequest"
},
"contactDetails": {
"$ref": "#/definitions/ContactInformation"
},
"advanced": {
"$ref": "#/definitions/depositAdvanced"
}
}
},
"TenantsResponse": {
"required": [
"externalId",
"info",
"flow"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The tenants unique identifier",
"type": "string"
},
"url": {
"description": "The URL that the tenant must use to sign the deposit, the url expires at `contract.paymentDeadline`.",
"type": "string"
},
"loanApplicationUrl": {
"description": "Url that can be used by the tenant to resume directly from the loan wizard. Only available after a bank-account has been created. The url expires 14 days after `contract.paymentDeadline`.",
"type": "string"
},
"bankAccountNumber": {
"description": "The tenants bank account number when an account has been created",
"type": "string"
},
"loanApplication": {
"$ref": "#/definitions/LoanApplication",
"description": ""
},
"externalId": {
"description": "Your reference for the Tenant.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"aml": {
"description": "If AML is required",
"type": "boolean"
},
"info": {
"$ref": "#/definitions/TenantInfo"
},
"ui": {
"$ref": "#/definitions/depositUI"
},
"flow": {
"description": "Defines the flow to use.",
"enum": [
"redirect",
"iframe"
],
"type": "string"
},
"iframeSettings": {
"$ref": "#/definitions/IFrameSettings"
},
"redirectSettings": {
"$ref": "#/definitions/depositRedirectSettings"
}
}
},
"LandlordResponse": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"organizationNumber": {
"description": "Organization number if this was specified",
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"ssn": {
"description": "Ssn if this was specified",
"type": "string"
},
"nationality": {
"type": "string"
},
"signUrl": {
"description": "Signature url for the landlord if `RepresentativeSignature` was specified.",
"type": "string"
}
}
},
"ContractResponse": {
"description": "Contract information",
"type": "object",
"properties": {
"monthlyRent": {
"format": "double",
"description": "Monthly rent for the contract if this was specified",
"type": "number"
},
"depositFactor": {
"format": "double",
"description": "Deposit factor if this was specified",
"type": "number"
},
"depositAmount": {
"format": "double",
"description": "The Deposit amount",
"type": "number"
},
"paymentDeadline": {
"format": "date-time",
"description": "Date used to inform the tenant about payment deadline.",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
},
"depositStatus": {
"description": "Overall status of the deposit",
"type": "object",
"properties": {
"depositStatus": {
"description": "Status of the deposit",
"enum": [
"CREATED",
"PAID",
"PAID_PARTIAL",
"TERMINATED",
"SIGNED"
],
"type": "string"
},
"funds": {
"format": "double",
"description": "Amount of funds in the deposit",
"type": "number"
},
"lastPaymentCheck": {
"format": "date-time",
"description": "Date the deposit was last checked for funds (ISO 8601)",
"type": "string"
}
}
},
"RentObjectRequest": {
"description": "Rent object information",
"required": [
"address",
"postalCode",
"city",
"country"
],
"type": "object",
"properties": {
"address": {
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"address2": {
"maxLength": 100,
"minLength": 0,
"type": "string"
},
"postalCode": {
"description": "Postal code",
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"city": {
"description": "City",
"maxLength": 60,
"minLength": 2,
"type": "string"
},
"country": {
"description": "Country",
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
}
}
},
"ContactInformation": {
"description": "The company's contact information",
"required": [
"email"
],
"type": "object",
"properties": {
"name": {
"description": "The name of the company.",
"type": "string"
},
"phone": {
"description": "The phone number of the company.",
"type": "string"
},
"email": {
"description": "The email address of the company.",
"type": "string"
},
"url": {
"description": "The URL to the company's website.",
"type": "string"
}
}
},
"depositAdvanced": {
"description": "Optional settings for advanced configuration",
"type": "object",
"properties": {
"tags": {
"description": "A list of tags to add to the deposit. These tags can be used to query for\r\ndeposit data and will also be added to all events that are triggered for the document.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"LoanApplication": {
"description": "Loan application information when a tenant has applied for a loan",
"type": "object",
"properties": {
"status": {
"description": "The status of the loan",
"enum": [
"unknown",
"pending",
"paid_out",
"rejected"
],
"type": "string"
},
"lastCheck": {
"format": "date-time",
"description": "Last check of the loan (ISO 8601)",
"type": "string"
}
}
},
"TenantInfo": {
"description": "Tenant information",
"required": [
"firstName",
"lastName",
"mobile",
"email",
"nationality",
"address"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 2,
"type": "string"
},
"lastName": {
"maxLength": 50,
"minLength": 2,
"type": "string"
},
"mobile": {
"$ref": "#/definitions/depositMobile"
},
"email": {
"description": "The tenants email address",
"type": "string"
},
"nationality": {
"description": "The tenants nationality",
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"address": {
"$ref": "#/definitions/Address",
"description": "The tenants address"
}
}
},
"depositUI": {
"description": "UI settings for the deposit process.",
"type": "object",
"properties": {
"language": {
"description": "The tenants's preferred language. This language will be used when signing the document and in email/SMS notifications.",
"enum": [
"EN",
"NO",
"DA",
"SV",
"FI"
],
"type": "string"
},
"styling": {
"$ref": "#/definitions/depositStyling"
}
}
},
"IFrameSettings": {
"description": "Domains allowed to iframe the generated url, required for `iframe` flow.",
"required": [
"postMessageTargetOrigin",
"parentDomains"
],
"type": "object",
"properties": {
"postMessageTargetOrigin": {
"description": "Domains allowed to send webMessages to",
"type": "string"
},
"parentDomains": {
"description": "The domain(s) your website is hosted on",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"depositRedirectSettings": {
"description": "Settings used for navigating when lifecycle events occur, required for `redirect` flow.",
"required": [
"error",
"cancel",
"success"
],
"type": "object",
"properties": {
"error": {
"description": "The URL that the person is redirected to if something goes wrong.",
"type": "string"
},
"cancel": {
"description": "The URL that the person is redirected to if the signing is cancelled.",
"type": "string"
},
"success": {
"description": "The URL that the person is redirected to after a successful signing.",
"type": "string"
}
}
},
"Address": {
"description": "Address information",
"required": [
"street",
"postalCode",
"city",
"country"
],
"type": "object",
"properties": {
"street": {
"description": "Street name",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"postalCode": {
"description": "Postal code",
"maxLength": 35,
"minLength": 1,
"type": "string"
},
"city": {
"description": "City",
"maxLength": 60,
"minLength": 2,
"type": "string"
},
"country": {
"description": "Country",
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
}
}
},
"depositMobile": {
"description": "The tenants mobile number",
"required": [
"number"
],
"type": "object",
"properties": {
"countryCode": {
"description": "The country code.",
"type": "string"
},
"number": {
"description": "The mobile number.",
"type": "string"
}
}
},
"depositStyling": {
"description": "Styling options for the UI",
"type": "object",
"properties": {
"colorTheme": {
"description": "The color theme for the application.",
"enum": [
"Default",
"Black",
"Blue",
"Cyan",
"Dark",
"Lime",
"Neutral",
"Pink",
"Purple",
"Red",
"Teal",
"Indigo",
"LightBlue",
"DeepPurple",
"Green",
"LightGreen",
"Yellow",
"Amber",
"Orange",
"DeepOrange",
"Brown",
"Gray",
"BlueGray",
"OceanGreen",
"GreenOcean"
],
"type": "string"
},
"themeMode": {
"description": "The theme color mode, specify if you want it dark or light themed. Defaults to light",
"enum": [
"Light",
"Dark"
],
"type": "string"
},
"spinner": {
"description": "The type of spinner to show in loading screens.",
"enum": [
"Document",
"Classic",
"Cubes",
"Bounce"
],
"type": "string"
},
"backgroundColor": {
"description": "Override the application background color (use hexadecimal value)",
"type": "string"
}
}
},
"UpdateDepositRequest": {
"required": [
"landlord"
],
"type": "object",
"properties": {
"landlord": {
"$ref": "#/definitions/UpdateLandlordRequest"
}
}
},
"UpdateLandlordRequest": {
"required": [
"address"
],
"type": "object",
"properties": {
"organizationNumber": {
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"ssn": {
"type": "string"
}
}
},
"CreateDepositRequest": {
"required": [
"tenants",
"landlord",
"externalId",
"contract",
"rentObject",
"contactDetails"
],
"type": "object",
"properties": {
"tenants": {
"description": "Array of Tenants",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Tenant"
}
},
"landlord": {
"$ref": "#/definitions/LandlordRequest"
},
"externalId": {
"description": "Your reference for the contract.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"contract": {
"$ref": "#/definitions/ContractRequest"
},
"rentObject": {
"$ref": "#/definitions/RentObjectRequest"
},
"contactDetails": {
"$ref": "#/definitions/ContactInformation"
},
"advanced": {
"$ref": "#/definitions/depositAdvanced"
}
},
"example": {
"tenants": [
{
"externalId": "24DE0123-6989-4FC0-9139-8577CF8D994F",
"aml": false,
"info": {
"firstName": "Kari",
"lastName": "Nordmann",
"mobile": {
"countryCode": "+47",
"number": "12345678"
},
"email": "kari.nordmann@idfy.io",
"nationality": "NO",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
}
},
"flow": "redirect",
"redirectSettings": {
"error": "https://idfy.io#error",
"cancel": "https://idfy.io#cancel",
"success": "https://idfy.io#success"
}
}
],
"landlord": {
"name": "Ola Nordmann",
"organizationNumber": "998303168",
"address": {
"street": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"nationality": "NO"
},
"externalId": "B35D3A5F-0701-414C-84F0-37ECCA83A0D5",
"contract": {
"dataToSign": {
"rentContractPDF": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhuYi1OTykgL1N0cnVjdFRyZWVSb290IDEwIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMjAgMCBSL1ZpZXdlclByZWZlcmVuY2VzIDIxIDAgUj4+DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4NCmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9Gb250PDwvRjEgNSAwIFI+Pi9FeHRHU3RhdGU8PC9HUzcgNyAwIFIvR1M4IDggMCBSPj4vUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldID4+L01lZGlhQm94WyAwIDAgNTk1LjIgODQxLjkyXSAvQ29udGVudHMgNCAwIFIvR3JvdXA8PC9UeXBlL0dyb3VwL1MvVHJhbnNwYXJlbmN5L0NTL0RldmljZVJHQj4+L1RhYnMvUy9TdHJ1Y3RQYXJlbnRzIDA+Pg0KZW5kb2JqDQo0IDAgb2JqDQo8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDIyNz4+DQpzdHJlYW0NCnicrc69asMwFAXgXaB3OKNUkKzrWJYEIUOcNLQ0Q7HbDiGDoYoJuKJ/9Pkrhwzt0KnRdnQv93wo2tc+YT4vts3NCqa469MAEZN6aOVigeWqwRtnRpvpeV8HGNhgdQlfkQ4l3iNnT1dInC07zoprApE2FboDZ5SXDQjOaF9WcLXRNk9e8t6mdRg+8mUMp+TPacPZTjzGUSovnuVMHCXNxCBVLSCDOBylciLl/ymNco/ulrN1Lr7n7P9OIqd9+Ok88c6qmC0kYv8llRWfub8fJ028uMJ6Xbm/FPhdh/W2wTeReVsGDQplbmRzdHJlYW0NCmVuZG9iag0KNSAwIG9iag0KPDwvVHlwZS9Gb250L1N1YnR5cGUvVHJ1ZVR5cGUvTmFtZS9GMS9CYXNlRm9udC9CQ0RFRUUrQ2FsaWJyaS9FbmNvZGluZy9XaW5BbnNpRW5jb2RpbmcvRm9udERlc2NyaXB0b3IgNiAwIFIvRmlyc3RDaGFyIDMyL0xhc3RDaGFyIDExOC9XaWR0aHMgMTggMCBSPj4NCmVuZG9iag0KNiAwIG9iag0KPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQ0RFRUUrQ2FsaWJyaS9GbGFncyAzMi9JdGFsaWNBbmdsZSAwL0FzY2VudCA3NTAvRGVzY2VudCAtMjUwL0NhcEhlaWdodCA3NTAvQXZnV2lkdGggNTIxL01heFdpZHRoIDE3NDMvRm9udFdlaWdodCA0MDAvWEhlaWdodCAyNTAvU3RlbVYgNTIvRm9udEJCb3hbIC01MDMgLTI1MCAxMjQwIDc1MF0gL0ZvbnRGaWxlMiAxOSAwIFI+Pg0KZW5kb2JqDQo3IDAgb2JqDQo8PC9UeXBlL0V4dEdTdGF0ZS9CTS9Ob3JtYWwvY2EgMT4+DQplbmRvYmoNCjggMCBvYmoNCjw8L1R5cGUvRXh0R1N0YXRlL0JNL05vcm1hbC9DQSAxPj4NCmVuZG9iag0KOSAwIG9iag0KPDwvQXV0aG9yKERhbmllbCBTdG9yZW5nKSAvQ3JlYXRvcij+/wBNAGkAYwByAG8AcwBvAGYAdACuACAAVwBvAHIAZAAgAGYAbwByACAATwBmAGYAaQBjAGUAIAAzADYANSkgL0NyZWF0aW9uRGF0ZShEOjIwMTkwMjA3MTQxMjQxKzAxJzAwJykgL01vZERhdGUoRDoyMDE5MDIwNzE0MTI0MSswMScwMCcpIC9Qcm9kdWNlcij+/wBNAGkAYwByAG8AcwBvAGYAdACuACAAVwBvAHIAZAAgAGYAbwByACAATwBmAGYAaQBjAGUAIAAzADYANSkgPj4NCmVuZG9iag0KMTcgMCBvYmoNCjw8L1R5cGUvT2JqU3RtL04gNy9GaXJzdCA0Ni9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDI5Nj4+DQpzdHJlYW0NCnicbVHRasIwFH0X/If7B7exrWMgwpjKhlhKK+yh+BDrXQ22iaQp6N8vd+2wA1/COTfnnJwkIoYARASxAOFBEIPw6HUOYgZROAMRQhT74RyilwAWC0xZHUCGOaa4v18Jc2e70q1ranBbQHAATCsIWbNcTie9JRgsK1N2DWn3zCm4SnaAwTVS7C1RZozDzNS0k1fuyHmptD6Ld7kuTzgm6mNGuwnd3JbuIIbojc/SxhEmvKz16UH2Xno0N8ypdPhB8kS2x+z5w5+6Vprys+SGPHjTPkE6ZfTArVPf0oNf9mXs5WjM5XF7nrRnIsclHe5kac2Iv5/9OuIrJWtTjQZ5rU400vbneFllZYMbVXWWhrsmXdMW/Mfzf6+byIbaoqePp59OfgBUCqK7DQplbmRzdHJlYW0NCmVuZG9iag0KMTggMCBvYmoNClsgMjI2IDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCA1NjcgMCAwIDAgMCAwIDAgMCAwIDAgMCA0NzkgMCAwIDUyNSA0OTggMzA1IDQ3MSAwIDIzMCAwIDAgMjMwIDAgNTI1IDAgMCAwIDAgMCAzMzUgMCA0NTJdIA0KZW5kb2JqDQoxOSAwIG9iag0KPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyNzgyNC9MZW5ndGgxIDk1MzcyPj4NCnN0cmVhbQ0KeJzsfQdcVFf69jn3ToNhYGYYYGCAmXFoOih2sURGKRZsqGPAClJNsMSu0YQUNSGamE3vpu+uKcNoIqaa3k3vm2KSzWY3MWXTLfA9575zEN20f3b/my/fNy888zznPe859/R7/AUC44wxKz50rLp0dMn01NKkCxivKGFMP6B09ITiD6eu7sn4pCzGVM/kaQX9L3uw/37G+FkoVV27sGbJ41c8v5uxBauRH65dudyze8lrgxi7RpS/p2FJ48JT3laHMLYwnzGLv7F5TUPampd3MXYjiheHm+pr6r49/9t7UV8cHIOb4LDcmi7qR3mW1bRw+erPxjkWIP0RY43nNi+urdmx45GLGPtoJ2MDCxfWrF6S35GTg/wmxHsW1i+v+cv16ZMZn7FatG9RzcL6sx98eAjj6Z8w1i9pyeJlyztdbCP6oxPxS5bWL0ls7JHK2NpKPO5jJsbCMOghJfXM1HkJI75mqSYm7O6P1z0t+JUtB9YePHC4JeYT02AkY5jCyFDOwDoYfzh228EDB7bFfKLV1M1SbxGeNBc7n1nZaqaipJUVsE2M2QfjuQpyVZ2fb2V6ZtJfph+AKjOJ1efYRoWZmJKgVxRFpyq6d1mvzj0s62StBbCJ0zweFmDsoI7aYLxayfEw3iny1F36eNFT5tDFH2kNf5b9f2+GV9ktv3Ubfq3pWlmPf6e8+hVW33/QdPXs2qPqbzk6/aPtmMKu1Z3Omn8qhn/y03Uh3/Zjecq7P1zWYMBzz/9lbfyfmLr/F/a7iqX/6mccZt5fW1Yr/zKb/e+U/znTDWTVRz3vIJvzS8opJ7Hsrjq2d9MjjuifMsPKXxb3Q3bsM0Rduv1HfMY8lq0+zAb9S7lj+nqs8VfYhp97NmIu+3di0IafLf9rTHny19Wr3Hb0+tR9yLy6FT+/ZkWMPpF5jeXMa3j95+N/SUx3U6/6987M7qbcwkq69F/ZWKWdjeEPsCzlEtZL+Hgtq5H5fC6db8qHR59z/BtK8/eZT8vfwNz/qfb9XgzrmvG9v3Uroha1qEWNTLmCx/5oXjXb/99sy+/F1EHsnN+6DVGLWtSiFrVfb7oHWMN//ZkL2bk/F6O8z9L+G22JWtSiFrWoRS1qUYta1KIWtaj9/u2X/DszalGLWtSiFrWoRS1qUYta1KIWtahFLWq/nfH/lZ9yj1rUoha1qEUtalGLWtSiFrWoRS1qUYta1KIWtahFLWpRi1rUoha1qEUtalGLWtSiFrWoRS1qUYta1KIWtahFLWpRi9r/3Drv+q1b8F8yNYL0yF8L+gQpKOU9pmPPId2LeaDE/43awnqwiWwGq2GNbAFrZovYUracrWTbeL+MoZ4Yz6nZTx/UdWp/8Qexnkhs3Y/GMsTyzq8x1t+yDO1vlnzFVW7iaTyHj++sZYM+3rQ/d1/NO8cxFmlbTqTNWT/aG7vojTpevQS1ZPI8PoX7eR8+hhfycmbg32gx3xz7d5GQViJ/RUlhP21UUnvCzw/tr7CSf/Es+8FmaO2UfYTS/roJXwysjERsBi4H9vyvtPM/b+ovCxOz+csr5Q3/z61iFpi5ccPyZUtPWrJ40cLmE09Y0NTYUF83f97cObNnzayqDE6fNrViyuRJEyeUjx83dkxZaUnx6FGBopHHjRg+bGjhkMGDCvr0zs/Lyc7y9XA7HTZrgsUcG2MyGvQ6VeEsv9RXVu0J5VSHdDm+sWN7i7SvBo6abo7qkAeusqNjQp5qLcxzdGQAkQ3HRAYoMtAVya2eEWxE73xPqc8TeqbE52nnMysqobeU+Ko8of2anqhpXY6WsCDh9aKEp9TZVOIJ8WpPaahsZVNraXUJ6mszxxb7iutje+eztlgzpBkqlOdb0sbzRnJNKHmlw9oUZrKIx4bU7NKautCUisrSEpfXW6X5WLFWV8hQHDJqdXkWiDazczxt+XtaN7db2fxqf1ydr65mdmVIrUGhVrW0tXVTyOYP9fSVhHqu/cCJLteH8n0lpSG/D5WVT+16AA/ps60+T+vXDI337f/kaE9NxGPItn7NhBRd7Bom5EvN0Da0EP3zekVbzmkPsPlIhFoqKintYfNdYRYo8FeFlGqRs0fmJAVFTovM6Spe7fOKqSqtjnyvbHKGWuZ7eudj9LXvbHwj3xNSc6rn1zYJrqlv9ZWU0LhNrwwFSiACNZG+lrb1LUB8TTU6sUAMQ0VlqMC3JOTwjaYAODxiDhZMq9SKRIqFHMUhVl0bKRUqKC0R7fKUtlaXUANFXb6Kyt1sQOe7bQM9rh0D2EBWJdoRSi7GpOSUtlbWNYTc1a46rM8GT6XLGwpUYfiqfJX1VWKWfNZQz3fxOK/2RK0U+nZMtAwWPTdmmzyVikutErMFh6cMH77RI5BhxXRpSTGjo0d4KrmLyTA8JRIh1FH1IKFmF48VWaooWjzW5a3ykv1Ek1yRNumzQ6ZudVnh6GoTPedHm0bRokE9PaX1Jd0aeFSl+kgDI7X9cDsVMRaRB6OESUznWJmlZmPnwqegGs0lZtHpCbEpnkpfva/KhzUUmFIp+ibGWpvf8mm+8oqZldpsR1bJ9KNSlF9IqRDzIlsmlGKswTK/S06rlh6jpbuSY4/JHiezfaJdra11bUzNFkvZ1cY1oS8+pyo02V/lC833+7yinb3z20wszju9uhh7tQzHna+sxuexespaa9o7W+a3tgUCrUtKq5uGYV+0+sbVtfqmVY5waY2fWrnetVY8287Kefn00ahKYaPbfPysirYAP2vazMrdVsY8Z02vDCtcKa4eXdWWhbzK3R68ADSvIrzCKRIekRA1TUXCpMW7dgcYa9FydZpDS9e2c6b5TNLHWW27Qj4rPShHe1AAd6Hadh3lBGS0Dj4T+VooOi8SbUKOVeTcxRRxfxSZZG1MDHAgVh8wBWICcYpFwZAKVxieuxAbw9mOOG7hrjbUOVVzt/OWtpiAa7dW09RIZAsiha+ly4eWi7BuFeF51PHgkR4EZ1buiGOoX/tExGhhWIXOJqwhvE9KPXVi/a2ramqtrhKnB0vGWsU3D3HfSBZSfCPRYkNcKNZXPzpk9o0W/iLhLyK/QfiNWPk8mWOyxaHbWu3DQYwdU8lcnPaaKqr0tHd2Tq/0PuPaX+XFXpoNzKwMxfjxctNnj0fcGIFquMeEWmprRDtYsFKUNWaPq63CvpQVImRcKAY1xERqQESZVkbsNxSqxVqr8WkSbhwdLVWhKr94aOWCKm2/WkNsrG9YyJBDdepzxIMKqlrtvv7a4YO9Hpu9SVAM2samVZLHhSQeVkWDZIxDy2t9yKqt9tAamYa9TC+LWBd56nHm63LqNcS6IplMdEvNNltiQzF9UCG+hTb3EWeOPttYVUWN11KbIgF4tjVkRotyug1lpABGB1njRFvwvQlNFaEPiGoq2tlU32ocnaLRWk1GZIcs2eNq8Haj8mZ4fIWysEkcguZIHQ+T1yh6Hodxx5HQ3nmzb423m+HsEG8/sf6Yazc2KqtqPdYRmuXvnW861mvR3K2tJssPF6DxMlm6WHMq2bXirQAWC05bb55S8ar0jW9TJvk15hq3jvfhDaJkC+Cio2L7eD11VSIKTZ6inWU/GsS7BYnXtFZ5q3W4TPFIiiazNdR4dLKpK1kmgMtgdh+6Q6Ar4qzFWjnBFWrGypQhYkY8rR6rb5hPfGiFxwhUY5K6tgWWP1ad2DQttZ7K+VjsqLCsurWsVVxRa2siwxZ5UmiR/6gqsS84Fg8qEt0JtUzxVFd5qnE15RWVXq8LuxHsacA91VcjXgVTqD9TZmpXlZpWscQZbipVrpARL6aGmnqfF2+QkDiBaPRFG3WRbcNcra2+1pC2b8sQjOpzsO3GCcL3Er+vpl5coRvEDbpeK1uG5mqjI2pzlfqwl+vh1sYSA4ejb774qG0VF/Q51X6MhK3V3uoZ2oojeA7eHrqc2hnVeFWJN5JHm+oaF1IYhHEiVYWKKDAmWwTSFhCtWehvm2PMPuLRvhf7Kdik1YqWTa0MTZEh2n4S4iR/SEkpRKboPJ86s1KeU6rIHofhDWBVuURpT0iZXhmZHq38OFHUJSeMisGjvUMi+6vrbSPfQ7NdGNMf9ePloI6apjyuPMoKmVt5LMJvsULlDRZUXge/Cn4twq+AXwa/BH4R/AL4efD94PvA94LvYUGmU95kA4HpgNql6oAbgJcAPTsRNXFmRnnOHMqDrASoA5YDFwJ6xN6HvBtQI2ce5cydMU4+HhN6hhSnS3GaFC1SnCrFKVKsl2KdFCdLsVaKNVKslmKVFCulWCHFcimWSXGSFEukWCzFIikWStEsxYlSnCDFAimapGiUokGKeinqpKiVYr4UNVJUSzFPirlSzJFithSzpJgpRZUUlVIcL8UMKYJSTJdimhRTpaiQYooUk6WYJMVEKSZIUS7FeCnGSTFWijFSlElRKkWJFMVSjJZilBQBKYqkGCnFcVKMkGK4FMOkGCpFoRRDpBgsxSApBkoxQIr+UvSToq8UBVL0kaK3FPlS+KXoJUVPKfKkyJUiR4psKbKk8EnRQwqvFB4p3FJkSpEhRboULinSpEiVwilFihTJUiRJ4ZAiUQq7FDYprFIkSBEvhUWKOCnMUsRKESOFSQqjFAYp9FLopFClUKTgUrCI4J1SdEhxWIpDUhyU4oAU30vxnRTfSvGNFF9L8ZUUX0rxTym+kOJzKT6T4lMp9kvxiRQfS/EPKf4uxUdS/E2KD6X4qxQfSPG+FO9JsU+Kd6V4R4q3pXhLir9I8aYUb0jxuhSvSfGqFK9I8bIUL0nxohQvSPG8FM9J8awUe6V4RoqnpXhKiieleEKKx6V4TIpHpXhEioeleEiKB6V4QIo9UtwvxX1S3CvFPVLcLcVdUuyWol2KXVLcKcUdUuyUYocUYSnapAhJcbsUt0lxqxS3SLFdij9L8Scp/ijFzVLcJMWNUtwgxfVSXCfFtVJsk+IaKa6W4ioprpTiCikul+IyKS6V4hIpLpbiIikulOICKf4gxflSbJXiPCnOlWKLFJulOEeKVinOluIsKTZJsVGKDVLIaw+X1x4urz1cXnu4vPZwee3h8trD5bWHy2sPl9ceLq89XF57uLz2cHnt4fLaw+W1h8trD5fXHr5UCnn/4fL+w+X9h8v7D5f3Hy7vP1zef7i8/3B5/+Hy/sPl/YfL+w+X9x8u7z9c3n+4vP9wef/h8v7D5f2Hy/sPl/cfLu8/XN5/uLz/cHn/4fL+w+X9h8v7D5f3Hy7vP1zef7i8/3B57eHy2sPltYfL2w6Xtx0ubztc3na4vO1wedvh8rbD5W2Hy9sOL94hRLtyZjhzpBt35nBmEuh0Sp0WzhwGaqHUqUSnhDPjQOsptY7oZKK1RGvCGaNAq8MZxaBVRCuJVlDeckotI1pKzpPCGaNBS4gWEy2ikIVEzUQnhtNLQScQLSBqImokaginl4DqKVVHVEs0n6iGqJpoHtFcKjeHUrOJZhHNJKoiqiQ6nmgGUZBoOtE0oqlEFURTiCYTTSKaSDSBqJxofNg1DjSOaGzYNR40hqgs7CoHlYZdE0AlRMVEoylvFJULEBVRuZFExxGNoMjhRMOo+FCiQqIhRIOJBlFlA4kGUC39ifoR9aXKCoj6ULneRPlEfqJeRD2J8ohyqeocomyqM4vIR9SDqvYSeaicmyiTKIMonchFlBZOmwRKJXKG0yaDUoiSyZlE5CBnIpGdyEZ5VqIEcsYTWYjiKM9MFEsUQ3kmIiORIZw6BaQPp1aAdEQqORVKcSKmEe8k6tBC+GFKHSI6SHSA8r6n1HdE3xJ9Q/R12Dkd9FXYOQ30JaX+SfQF0eeU9xmlPiXaT/QJ5X1M9A9y/p3oI6K/EX1IIX+l1AeUep9S7xHtI3qX8t4hepucbxH9hehNojco5HVKvUb0ajjleNAr4ZQZoJeJXiLni0QvED1P9ByFPEu0l5zPED1N9BTRkxTyBNHj5HyM6FGiR4geJnqIIh+k1ANEe4jup7z7iO4l5z1EdxPdRbSbqJ0id1HqTqI7iHYS7QgnF4HC4eRZoDaiENHtRLcR3Up0C9F2oj+Hk3Fe8z9RLX8kupnybiK6kegGouuJriO6lmgb0TVU2dVUy1VEV1LeFUSXE11GdCkVuIRSFxNdRHQh5V1AtfyB6HzK20p0HtG5RFuINlPkOZRqJTqb6CyiTUQbw0k1oA3hpPmgM4nOCCc1gE4nOi2cFAS1hJNwGPNTw0mDQacQrafi66jcyURrw0l1oDVUfDXRKqKVRCuIlhMto6qXUvGTiJaEk2pBi6myRRS5kKiZ6ESiE4gWULkmokZqWQMVryeqo8haovlENUTVRPOI5lKn51DLZhPNok7PpKqr6EGVRMdTc2fQg4JUy3SiaURTiSrCjgBoStghnjA57BDLe1LYcQZoYtjRGzSBQsqJxocduBfwcZQaSzSGnGVhxymg0rBjE6gk7DgVVBx2tIBGh+1loFFEAaIiopFhO97v/DhKjQjbqkDDiYaFbWJpDCUqDNvGgIaEbZWgwWHbTNAgyhtINCBsywf1p8h+YZvoWN+wTezNAqI+VLw3PSGfyE+V9SLqSZXlEeUS5RBlh21ilLKIfFRnD6rTS5V5qBY3USaVyyBKJ3IRpRGlhq1zQM6wdS4oJWydB0omSiJyECUS2amAjQpYyZlAFE9kIYqjSDNFxpIzhshEZCQyUKSeInXkVIkUIk7EAp0J890CHQm17sMJde5D0AeBA8D38H0H37fAN8DXwFfwfwn8E3lfIP058BnwKbAf/k+Aj5H3D6T/DnwE/A34ML7R/df4JvcHwPvAe8A++N4FvwO8DbyF9F/AbwJvAK8Dr1lOdL9q6ed+Bfyypdn9kiXH/SLwAvTzFr/7OeBZYC/yn4HvactC91PQT0I/Af245QT3Y5YF7kctTe5HLI3uh1H2IdT3IPAAEOjcg8/7gfuAe+NOct8Tt9R9d9wy911xy927gXZgF/x3AncgbyfydsAXBtqAEHC7eY37NvNa963mde5bzOvd282nuP8M/An4I3AzcBNwo7m3+wbw9cB1KHMteJv5RPc10FdDXwVcCX0F6rocdV2Gui6F7xLgYuAi4ELgAuAPKHc+6tsaO8l9Xuxk97mxje4tsTe6N8fe7N6gZrvPVAvdZ/BC9+nBluBp21uCpwbXB0/Zvj5oXs/N613ry9efvH77+jfXB+yG2HXBtcGTt68NrgmuCq7evip4l7KRNSgbAiOCK7evCOpWOFYsX6F+tYJvX8FLVvC+K7jCVlhXeFaoccuDS4PLti8NsqVTlrYsDS3VDQ8tfXepwpby2PbOPTuWujLLwIF1Sy3WspOCi4NLti8OLmpYGDwBDVxQ2Bhs2t4YbCisC9ZvrwvWFs4P1hRWB+cVzgnO3T4nOLtwZnDW9pnBqsLK4PGIn1E4PRjcPj04rbAiOHV7RXBy4aTgJPgnFpYHJ2wvD44vHBsct31scExhWbAUnWfp1nRPumoVDZiUjpYwFx/d1xVwvev63KVjrpBrj0u1J6S505SeCam8eHIqX5x6aup5qWqC81mnEnD2zC9LSHk25Z2Uz1J0iYGUnn3KWLI12ZOsJom+JU+cXqZxUQlxv0FaX93JvpyyhCSekOROUko/S+Ibmco9nDNuBakmxOzkSe4y9V4ufthOzzjfyqb7y9tNbGp5yDRlVoifFcqeJj4DFTNDhrNCLDhzVmUb5+dWaT+TEHKIHyrR0hu2bGEZo8tDGdMqw+q2bRmjq8pDLUIHApruFJohpMo/d9mKZf7KwHHM9q7tc5uadL/1WauSkMATEjoTlEACGp8Q745XxEdnvBqI7zekLMHitijio9OiJgcs8Ij+5cZNmV6WYHablWCRebJZCZiLissC5t59y/6lnztEP+nJ/uVz8TF32XK/9o1UFV8hkn7hFd/LliMtvlZoaeb/SaMw0LxlsOXSufynS/3fbvy3bsDv3+gneUZ1KmeyOuUM4HTgNKAFOBU4BVgPrANOBtYCa4DVwCpgJbACWA4sA04ClgCLgUXAQqAZOBE4AVgANAGNQANQD9QBtcB8oAaoBuYBc4E5wGxgFjATqAIqgeOBGUAQmA5MA6YCFcAUYDIwCZgITADKgfHAOGAsMAYoA0qBEqAYGA2MAgJAETASOA4YAQwHhgFDgUJgCDAYGAQMBAYA/YF+QF+gAOgD9AbyAT/QC+gJ5AG5QA6QDWQBPqAH4AU8gBvIBDKAdMAFpAGpgBNIAZKBJMABJAJ2wAZYgQQgHrAAcYAZiAViABNgBAyAHtCN6sSnCigABxir4/DxDuAwcAg4CBwAvge+A74FvgG+Br4CvgT+CXwBfA58BnwK7Ac+AT4G/gH8HfgI+BvwIfBX4APgfeA9YB/wLvAO8DbwFvAX4E3gDeB14DXgVeAV4GXgJeBF4AXgeeA54FlgL/AM8DTwFPAk8ATwOPAY8CjwCPAw8BDwIPAAsAe4H7gPuBe4B7gbuAvYDbQDu4A7gTuAncAOIAy0ASHgduA24FbgFmA78GfgT8AfgZuBm4AbgRuA64HrgGuBbcA1wNXAVcCVwBXA5cBlwKXAJcDFwEXAhcAFwB+A84GtwHnAucAWYDNwDtAKnA2cBWwCNgIbWN2oFo79z7H/OfY/x/7n2P8c+59j/3Psf479z7H/OfY/x/7n2P8c+59j/3Psf479z7H/+VIAZwDHGcBxBnCcARxnAMcZwHEGcJwBHGcAxxnAcQZwnAEcZwDHGcBxBnCcARxnAMcZwHEGcJwBHGcAxxnAcQZwnAEcZwDHGcBxBnCcARxnAMcZwHEGcJwBHPufY/9z7H+Ovc+x9zn2Psfe59j7HHufY+9z7H2Ovc+x93/rc/h3blW/dQN+58aWLet2MRPmnDeXMWa8mrGOC476TZIp7AS2jLXgayPbwi5g97M32Xx2BtRlbBu7if2JhdgD7An26i//nZqft441+oUsTt3FDCyRsc4Dnfs7bgLa9fHdPBcglajzHPF0Wjs/Pcb3accFndaOdoOdxWplLcoL8H7JD3cewCsX6c7BIq1sgk7QSnxhvLrj9o6bjxmDCjaTzWKz2RxWzWrQ/zrWxBZgZE5kzWwhW6SlFiGvEZ8NSM1DFI4XTR+JWsyWAOI3gFawlfhaAr0skhJ5J2npFWwVvlazNWwtO5mtY+sjn6s0zzrkrNXSq4FT2KmYmdPY6ZqSTJ4z2JlsA2ZtEzuLnf2TqbO7VCs7h23GPJ/LzvtRveWo1FZ8nc/+gPVwIbuIXcwuxbq4gl15jPcSzX85u5pdgzUj8i6C5xpNidx72KPsDnYbu53dqY1lLUaNRkSOS4M2hkswBuvQwzO6tZjGb1XXaJ2Cvou+tUZ6uhr+07uVWBkZRxF5BiKpFpoHUcv6Y0ZiK/pA+kiPKHWR1v8j3u6j8lNeOR5XdhuZK7SUUMd6f0xfzK7CDrwWn2JUhboOmtQ1mu7uv7ordpuWvp7dwG7EXNysKcnkuQn6ZvZH7O0/s+3sFnwd0d0V8W3sVm3mQqyNhdkOthMzeSfbxdo1/0/l/ZB/R8Qf7vLsZnexu7FC7mN7cNI8iC/puRe++yPehzUfpR9kDyEtoij1KHsMJ9ST7Cn2NHuWPYLUXu3zcaSeYy+wF9mr3AL1PPs7Pg+z5/QfsHg2Cv/8vwvjfCWby+b+J0+3Y02fxpLYts7vOld1fqeOZQ18Oi6Qt2CWdrLN+Bf7oiOR3M1ide8xB9vZ+Y06G5x3+A19U8d1nZ8xPU7NZeoLOOVUZmRD2UQ2iV0S2uCvvIdZcEtJZsP4HXcklZSYehvvww1EYR7cYUyM8+JAgk6x7EpLK/LtGmTYotrGtfPeO4uMW3A7Lzr89uG9BYff3m8fWrCfF7y17+191i/22oYWDNj30r5+fV0BR5plVzOKDvLtah6kGrY0q7YiUT4Q01wUUIxbmlGJs8iftte/t8C/149q/H37VXGb16bBEa8YjQ6Dr0cfZVBuzuABA/qPVAYNzPH1iFc038DBQ0aqA/pnKqpDekYqIs3VFw7NVCcfNiin+IpmDNBnpiU4LAa9ku609x6RbZ02K3tEnwyjajSoepMxb8joHuXNpT3eMNoykpIz7CaTPSM5KcNmPPymPv7AP/XxB4t1zQcvVA3DZxdlqZfGmhSdwdCe6UztNdw7bkZColVnTrTakk1Guy0ur2T24Y1J6aKO9KQkquvwRMbZLZ0HDH6M/gj2ihj1gLV65JKRiqVv35SCgtg+Tmdae+dHO6x8IvjzHQkRtmj8zY44jT/aYRas2AKZWf3i4mKdCI+1JogPBMbGIirWiZDYu/DPLta5J5CKBMsaXGF2plgKnP36GNx5Fe6gPagPsiKYPWWobUARL3jJv097x/e3DbB2KdvQ4woGDLAN6Nd3DqbxB+twHqkEk5Ytp8Dm4/GqULncZ+tyDhSzl6mk8AEcUyZkksFvcrhTU7yJJqVjgGpOynAkZTrMSscYbnJ4Up2eRGO+q8nTN8sZw1fp+UZzmjsndWGCKzEuzRRn1OuNcSZd48ELjbFGVWeMNWCKLuvy39QrKy4tz3XoePWmzF6p5pjEjCTMQY/OA7omvYNlsY3aHGRkmTBCeVk8TXBOGs9L4TkWnp/K8508FQO+M8HKJ2gizsInOKVHiIBduFKdqc6cbPdUp94+VRtV+9Aim50PHVpQIMaxX182Zw6fM2eOf47ftasrzKnFiTHTBkqXy3NyBg/uNjz9k5MNRmWXLj41NyPZ67TFGdWOKhO35/VI99pjdHwZ5wtUkyMr051lUU2Z5niTynV6k9mkCye74nWqyRJ78H5dkfDr413J4rfOrZ0H1A90Oeh7HjtJ9P4OZ0puXI6lXeGBmJQcD/zmnNh2ZXjAynKyM3rlfhcXZ8+otzfpm8RiERvcZh/KUwucL+2zDR1qH5pmfYuE2OdWlIjL/a75SBknFfKjkOgoOqRt49xcr1F0Gh0eovU0U5di9Kle9Q2jas3xerMdJvX4jsBUXWxiVnqGL14x8QW6OGduZqrPaTeb1PXK7bxxRHIaOmmIi9n/cUyc6GJ6kvqIOd6ocmznOFNLR6zo8bWMqYdw17MzNxtJJ12iMhSnZJriCMTEOL+Pr3N9r29kRfuLcHZFDqy4eOf3zfF1etf3zcjC0VSkHUhiGaPR2jL2Yp6MA/vAYRPnkXpoXOvjWw46srIc3Nb6wBklobzgpubztzZsrMpX3Juf3jgqw6ve4M0oPfP+U6Zubhx26NN+9ZeI39QW7YtH+/JZpWhdW1puOxrmiPEkehJZTNq3OTmG1O8sdbnfGaiNdMY+I9aWdV9/0djEnLRvmxFmSf2u2VJnwPgbIm2OHKTanvR2a3eS5rAdI9EMo9lw+G+iD4rdaDbqkDZ2VPNGI4ZcNUFfxm82wF9iT7MZqT9Gq8tuT00wdTxttKYl2lKtxo4bjdZUrWe4PX+OnvnYFK1nepvomT3dbHaxdJf+e5stRXfQU5ciVlakWwUP460R6VaCTf99M2I8uoPNWhTWUterAW+Do9rf/YDx9k9WPk9I6FjDlxjiRCfiDB1bTYneVKfXYcL0fJ+QoL6Z5enYabKmJtrT0PbpJuqsSX3Sm+EVbW/u/FT9VNefBdgS0fYdmZkJTvHzLiwvoV0pDMQO8n2dqsdX31jxH/yGNTjaub2t74LIDIm50RbTw9gbBaIz5lTf181agWGixM7mYQ19RZlwMwpF5kqcFnKVoS/i9ZbkyMSLbPAQW9dbDZ1LsjkMRjpbIy86nfqp3hijS+g3YeGEGa01A4fUnl3Rpyb3EzmHfF6yx2rzTpk+o+epT2weN3nrEycXLw0OccSqmxNdVlNGdsaIEy6qmn9x46DkJJ6J6RNTasxwd9Q6Moz2tETzhM2Prj1179bJSW53ojsyt7wc50gSyxLjsxs7zbEz1lqvHRPoOfq8Q0th0o56K0TezEm8XDvdMSMxDo8z1eMwpcjWql8aSBnE//PAhifN1m9QcnDjY8yg5Ngiu0Z5Hc93soH0/EQ8nxkt9RjU+DadtlWwS7R2WOp1whtu1tG20NpjiGyISHO0taS8bk3ocDuyTA6v1iK+WLxESrOwJtSnZZsOnWa0uWgE9PVY3YXsBNGCnflJvXOd7bwzENPDUhDbu3ePgbEiZWM9BtX1TjarGTl1GU3WyDkq3pfilbuvvx0vWEw91jxOUW3ZHxsu36/Hvl0jJ+lPvV2Tk/T1xkRPSqrHblQ6ztH58nAniVE7LlOMdk9qqttuzHE2u/O9eLX21PH+canenukNqVlHZmLVoTPj4lRDjEFdd+jsLu9jPTzitXp4oPJ4Zq80s6dHZEWon2NGhrMJ2m732sWPC6Xr+rbzpwIWlj643twrRexjtZHeJJEBiOx2c/d8ZyQgMlM4csW7MdfnEDP1L71NTE5OGdBHPTKZ6uc90pa5c6wdH+VNzuVc4UZberIzQ/R2nc3lsJk6/MGeCocZ7OkpzgybYXQPj9urmMsvn9BjfPn4Hofv695XU4LT2pFVce3UvGBwRh7/Gu8WnQ4f2tsFvb4Sq2AAToo6WomxStLOfla/baD48cGc4dqhl5Dut304fHjK0G9ED2kNaEfeUOyV/i/tQ2df0V48dv9w24fNiPQM/aY5EitGQzv4hnZbAbm5fVSf75hzj45DY6aakpL8f9j7Eug2jjPN6gNo3CdxA0SDIACSIAGQBE9JJHiIgCiSkqiLtkRJFElJlFskJVKX7TixndjOZiY7iqV4vcnbJPOyOd7uTHzIsmInG+8bOYmTyBPveLzrxDk8mWcnziBZJy9jz8Si9q+qbgC8FMlvZnc2j/rF7uruqr+qvv+vv/6/upp0ciWT06c1jojfF3LouF3mylRX+rAy+MAceg98ZE8q0DRQ76uLhCy36YR/cKQ2Zy58vGOowWMXQPSc1qT/TU1v0ruwpQDLd0OBaN/hrvSujQ0WfSiVqfqF18P+OLw+7ln4S08Sf+3tB2Q6ABkRtRN9QDwA8aTTzFtgLD7pm9ARs9/AJK+8/Tz0/Anehx9clMgTbOobCna+0MlQ0QrCdNVhNi28rrWFPN5gmWbhdWWSYn+OW8n9MBJ6775Ce+/RWGGe8lkFPHihdSFo3WugrRVoM27dE8gFY/fXT1W4RJ3LAYY+o9O7ApNOlWzRwE+jPg91eIi383Th+RJHjl3FkZvmda5osKLGbeAXPqXmzZViMFwG3koDC6NPW1YRCISMvEDcOE5jMnDPO31GnhMM2vc+x+3VGWUnjkV7r+e5Tu47ROf+kXiwork72J3s5vRaV9oA/n8aRwJpHASkLdhTTV9m3smYUCxmRowB4VgBtePAArK244DCKJ/19Ey82/bLrCZTZnU9j9KWNLvuuTSD0kw6neiqucyAlfp+BVNRwQfeSvRveM0wyKOk7JuMYv8wOXp83yieALH3eyW+bxRP6iSiAOD2QSRh1LuYtOt5CfOrIAydEqpgnDzwTATekhL9hg2vSZivOyk7Mvv3jWIvMhkfpVZBjb3HpiZqBYlSNDal6awp3+GJMRDoPOrE0yjXafH7vEHTunPbsnPb6jrmvzR1t7N+qG3D2KZ6g8ag5QVf965D6bGHdkQ//6e9E93B27Z2zWxwGwxqtcFwe2dfpO9Q18Bsf6QvvbXJFwgHwIEwewLecMBeu/OeHVdcdZ3Vfdu7e0FGB0BGn1YdQ1GIsb9GZBTsXMfofW1YMm04RmuzWPABZNGGBdX2LPNPML8lr/8USyMph4FJOQxMytJKylJKXmZ1GZ091Kdvi/l4Uw3eKOTuBzHzT5oGVQN4ZIE0yBxDQ7mX5YiujQRyOqWgG5e8KLn7TbjsRYkUxoMPIF8y45Qi3eB0FY1tNFr0VDrYFu7TYG3LcOybfXTP+J/srmo4eG7/lvszQlkQJlWb9gs9H+jtHGnxONK7ukIbMn0xj4Y6aZrTg7sG73/84PyzH85u7GH1ghFHcUbh2sbtu9cfvDvTe9/kBltNTz2gOwroPgojII7S6C2Cbk2yubN5ppmzi4CeXQTI7PZQrQUgq8Xo1mLYa8lYqL3M/NNTvfHPx9k4gPoU5Iyn+csUdjj/CsNMrvXkTAcDj/EOhWq/9SH+z3j2OZ75Ps/wvD/5WrTf/dYB06yJNWnf8g+izmsvj8rj4PgJZQA0/Cg+ShJYe+NEABV87bekU4RHNPmaFO03ud+SkMliYs2cya99SwJe4KpcwUpPtH+04PXKODdSY68uXe5wxJqJLATu0Zjn2hPlfbPbMhObkgbwWjiWE/TNu45nZr54on398c+OH71woO4L3NnTG/Z2VLAsGwttPrMr4fA6BJPHZrSbDXqP295x5+U7579678beuU+N2O87nxiYbMG2MwJ+/QOqM2g9eojYTqcFAV4X8SqDT16uwGcCnE9et/DJiuvD269TNZHL17+fsVmszEBEl2/OeqP5VE4csOTIvNiAA7H4lca3qfVovIInRmuzLi9BzlQ0L8l5ybzY0LnMZ3ZQbNSl0yOO2mQbQT1m9gGIlNWCo7zaF0mLphc0eq3KZn5BYxfdbtGu+aDFgqf4D4Zzx/rD3ZU4vDTbXSaVVq91N25rPyhYvfZK8b1f4mCbhwPnECvtEBSN7ntwV7XRbLD7ZKT451Rn0RhdabiYzVZsr8QIJAxOOGWCOypsFTbU1pjQ5G/Pbs9tyXf2hZ3gFeSqB/wDBgIH4AGAdGJMrjRewUFCI3Ga5MDCf7smL+GynVvyEi4NToVUKE98xzgwiHd2KhpEYFKviFJoVcCcrnLOUVI4VLzNPwdzkyNY5e3f8AK2oVZLAcUFaSmelbk7srXdDh0AikuJUGo9cz4Cd+M9Dq1R4FQW0Q+yODQ7vhzi5XDvHP3Irmqzlge87WJAi8vtHivewx4ayIC7BDKwo500lnt8I3qWnUY6FARB7NwmYkE4mlO123KD+fVZsTbfbFY156IDHmxGO1++asEKiYMJwP1Hb7/8+osYdue23PrBvAT5m2vzkjmjlMCAv+y9itWys0QvlRHK3QTU5epFQIMTz13SOmPlgZhLp3PFAuUxp9Z2A4SzU73O2kqfTs2zALPVG/FvbGcFr4f/nj+KOUT9/ohHq/VEfl9/I2gJjLxGq9Nb3FbRL2gEkInPTRFVvU0QvRs9QfR669a6MxjHi7WjtRK6zM5c0tUCtQWxrt+9t47oes+GtjM5s0rVM58fz+7NjeQ39dWJbfmeXOOAAnZB18HiXVUgf53G06+/iNclIV4iah8GVhngNT6flzC3TSN5CfPractLBY6LtB8Keq/etExuIB5+hXGwXGaqt7WuUpm5iMzwMqewcMcfGh9BZXhUe8jw6AOR1oVBpCpWZxRsnqhv4zoQqfemRbrayDEuGzgrSJzYMe7zYPG3oiNE3sFguE+HZbvVE8ayLWtrTG7us+c7s2FqvDw5lSLQwth5uWCzHJv7Ou1grbJhxViR/LK4lAhdwV+tvjXL7qLvAhzc5xVwWY2gTzWlnB1bE9avUhP11aXA1+x+YNTb2hRzmTgIF0UvfuZRQOOf5zg4etLDLata/gOjD+ys5gVB0Gl0Bh0NEAlyqp/AWDmNPkP8FO327alkMKgnuD11IJlcf0yPgTy9P4WBDPRl1p8AIA9l9+f25Af6UuH1+b5c80AJooUxUoTVht+0YHCt8ugQT/QdAoAxl4E9eQnz6Vufl0o4EawLY+OWAL/VocG7FPdE9RNlCHAawZBsSjlAIrZnwNzzVvMzNz0o6JwhC6zKaeLJYsYieX2TyqtpW8stTCMrDAYsTm1BnESev+b/K4yESfQwmUsy/ZeZdzOGyXAYpScnDX0jjQjk+KTTYhgChzrj2D+YyTXm2tuddXl/th8Z8s6cmrjnWIggrU4ysRM5XsFitCnLn4/vJwy8UoGDvy4vYR5OQ14iXNyyACkb+sbsRqIpdZFCBZ+xVMTOEs+Sp3yYo8tcouwxiIDKDQLHqTUqTRn2oBrB4/6kxoZf19g0b2iMGvCl3mzOOSN+hwCZeK2lvDrpzE5kAlxiFaeJwl/qY70CoS/Paw3CK1SGC7rR/VqdVmVy2wIVFpNWHdk8N8SaqFTUb8Io+zP0PWKfOjq8Q9jTfCq2d69RMuGZybvFe/Z+PMRqjMeMXqDYB1F9PHY2J+Xm5uoP5Xdmh3K5fEvf/T5TLF+fCw2UDTwIAnhcGMRLiURghampkww9LDCYmMisRA9EdrKNq5Q57zyUlzDvllxeItzrY3mJ8hdwBU9IAnH16WgsTFXKqil/izPTSjK+NdGr39RagiCsvolM+Y1mKuwZx3rLYVAucqSZ85VZ7DKHjVg/tGqhLEAegH4IZZTDG2CCVTbLG0Q/ykA/1PyeUoHeeKwOr6gsu/eNPri72mSSb0MBcnt8dR3Cvwm4aeFh7qPct1EHGkL7GSex0A5bXRZH5VkNhC1Z0WJnBrKNnZevv4vDmE45HofzTy/hR53CFkhmjGYbM7DFx5tTXKMg4OjRQmKe5zJGSNQ1Cj6f0FjH4zgpk8aB0giuYkS0QLGRmkhGD+eIOSVwrf0/MGz/ucNxoJX7xfpcjdj9amv/nlfFLfKLhU6yupJ/Bcf2ECM1XsUBkgu0EL9otMJNy9U4/I8rB6yJMcLX0P8DyeBwbP+5hJmv534hYfat3a9Krf3inlclqEJ+DdFJl1ks38RLAHLMEHY6qRJFY2pwdZwuEg4U/aiWaBS/hY9GlbAAXCAmHS0svXSw9nQ0FjNx8hX3Ubv53rC/YfRDQy3jPpurq/mXPbPDifQdXzh+7NGDtZZQvVifbIgEK9N77x2ozgYZi9W6sDA5msomXZN76nNJ1/b9234hVru1Hz61ebLDx82Hg5W7k0NnttcGnLZEeTjB6tjQhtvWdczurI9kbkuHOlobPZ6B2g0HopHR7sE7d9RpNaGFt/ceFls3Vd12KNiSu7avvZPVeOqqqxxdPYFUB44dDoB+fJr7DtoAns+DJNZtKN+KrQkymVAfXhMwVgXQcOumho6t5Xy4C3+hVde/GU5PhQfcv1RRsdGVGGtjI5N8/QqxEWSh31hSsg4XvSjV9Ydx4YxWCg+o3L+UVLJQ6GoMcCjO02plFJPNEE2LXgexrqbVV2dapM9J9ePbm8s0HMvDANXWbZrqzYx1i9X92WxMWbCpzm7MVmtseCHHKixbsokce/RArd7mMJotZYYyyGH32L0bJgcmq9sqzYP3f+Xg3DP3Z62RddXHtHRRVrvwDlnE6dx438R6W3VPPUb3I9f/mdmmSiIHCqEvYnSf7gxvCc+EOae8JumUFw/ItZ2cycByyqPQKS8qOJ9ljyM/ctC1B4dcyiE/dShrEQ6Yqi/pghkoiT90vOixbCI+1Sv5uLxSI6+SkTWaxz0401MSzQVz7TfjK77IsmOXB2s/qD3TQedAuyDY8UstcPlr17XH8U/BN+E+LND3BwKTaq+pboMfmMEeBSw6uK+VvE9j3r2okxuovE+TG7Ly+7RlVZfUCALgOBAFUmpSHYeatlHMXVtcMy4OySs3SEYPyeghBT10mbSoT2mRgtOT5Nb7aJaqtfAihbSK+yyMtAZ0mVhhs80CldvxoTPN1Nhx60Dydlnydrm1drm1drm1duyN+cr1eG1Vj9f89NjO6vF6qx6vA4Kv/e7TKIP7V265zKgzurr+Gk/lJs8A9a6xhWXAllI9kLfB4DVTFI/7Hq8jRfRSSRn6pqpziWoQD1iwLkPDQd8KOLjPAioEDXdiU6rj7l4FJPw+yhmwCAOPDN5+10CogBVrHtzXWzmy89rHlgv19M4tGw599IAsW/aL5M0AXW+abWKiZhkiswyRWRGoWcbQjDGzoQwMMJSxwgEvoSIvxHeRjDbeHzU7xE2OAUTfyOFVKIDkdQUX3+NxklEnFXO6adal63Ir4UFCNTX7RVat1WhcgUqHJ9XUHl6KRqSrvS1gDFUGDDzHcAed5VatVqspSwy0XHtsOR73N/fGzJxGp9OafORNz6/ZY/xfoHb0UYJJNbKG62Q1qpMhqJMxqpOX3etkrOqIc+8y1uXDuYAx78rVF13C/FUMRqO8rn71CnmLCazzEuR1ZVzGvOTKCfWlLl7ca7mqqAq/sgu3ilPGHtNYxOqEC5yywD1mmwo87A8oA+pNHNGCu92SdVX6yzQqrWqxO0Xdphs4QgQj/vcQ1Uyg82RP0HBXV8NEI+68Z8gfbUANFUDGkaGJ3L596sboUH4k14KjE11usHbAn3Pm1VnZS8Z+MnZfAZkrsnd8VV6tJG6xWWYxMpSXRnKUi1GibNTOvASMZGcYu8OYE9aixY6sPKWtEpuuEMOsADLXDv7rpooevLJLwph4inipL9DY5TuKCi7ES2BdXQbc08WFX+KW2vSrLBOXBjEh66pCwjsfQCrcr1VJNsp8CSEksBH2PyH67vLX3Gug0V10NeaJZJcF2+Z4eXncjCMcA9cU78pZ4vl1Tbky/EooMqilr4Su5htAMmRJDbshRCJGyNoUz0vrMk25SBl5C0Tyk7dAZCUTS4DsOrl1lL9U7tSQ/QcQQSRvEkmf971Hbh0vWYtf4v8XxOZfkHEx4d/yEh8aIeuPxm6jHwg1xXegoVxXbt06MZfKsbkRUzzflLPhgRoZ3FsywLEuXxml4d4VHJor0Z4CnYeyQTlLjtVzuaYREwYSYLTJMAp7Fw1/rNIW/E5npfjOueytzkqIhoo7VlayE/xLGiuNtDvLF7pKAGc5wVxetTLkzDeU2O4NYkpMbzZnC5H7nkDIYtLJqJcIw1pmNRqNq4mDYZQ9mAvXV7Y3wgGwNx9HLxJJHZzvwZLad28MO9fdJ7stXiyyaPS+6LbupqjTGW3q3qZCR/bdNX3X9BFd/qHsvbn5XE/Muy9/JJfFGI8MxuH01PrBwlskKr8GutECJIctEo2USkJ2RZJewvghXV4qsD6yLy8dyY1kiShHBtdj/pckuQI3tVA0ZO+UN2/dzHuolYfOTQ+oEvEXonvhAK+CONtB4uygufAmyxaikXttiTQFayi2gnZoLKE/qBvMyzjij3RVGP/wu7BVBu1NjuVS5SFmlYT1skVUbycW8SK1iCpWsYjqLhj5R9GTRJ+CHVuIITzacNR0dHT0qInzDeFV1u567MU+EfFtx/OOa2IwN9CRq8/F42JrqpVt3YJ8+UiOxybAQU2AYgA66VyPLSfRIaI8WHMenyCsyqUiL9RqaQVz0BrZgiK+vBTJOXhiBRyyFSixAYVVu1uX/k0YZGayVMTW4CoWtyhitifgIiu0YpmwkCxRm6JR4RKrrMLdSIirW/TSZTy6M5u7C6KgWsZIo6Dw9XczLr2BGQhq8DESZMppopwhQaAc3uFzWSEEoGebfLbC80wLJFqsTNTKxCxMlYqpqIIbGyqYygomhJOdIaYyxIjkrshUikzMzJwKMSH8mlprdeRCInjHIbzfWwvuYQjvL8BX2GcMYf4GKBiq2hTSezfpB+T9Qkn6DV18FNxkvPWb/Me7wEdpkIl3g8d9T6EQY1GRivRQUYEH3VMUB0WRzYpQ2E5fEufbXS12+dOHuxiWYxeu8kZvVXl5lcfEL7zIqxiNPegKhO1afoHnfs/q7CGfq9wqcJ/htTqD8N6X8V4jXmPScbsNNi0HEmPhoL3mNRjYN/Cealajx5F6L/s8m1H5UB140X9CRpjgaMe/thHhde/LzG2ZgDlyQRR9jnNigkklMgk2kdD5LlQdb3lYN8/NyftR8K6IvJVs9C1dCImIkQsSFE44zkkoYUn87wRn4KB8le+CVHVc1/KwRHjI21LknUDFfcAVq+4CihaGTukmIBYCxJA3Mtpeu7k5WLVZ6tlhDDZGI+vryjVGm2ndxIbe0TbvA8NV66K2htrazkr2ZwaD3piKVDtrO2sSG+ucYV+N32hzWMN+e1m5O9A8mPyQwSk6Y7HKGGCVA6zuVFtRJWpCtxOstJ6mZ5kRMFR1zEczFmvwmEfLVT3mPN7wKUMJNmSvzssyJHaSyVn1mOQ8bmj4lGQoBaCts/gm/+a25UCn7/SErE6zOjm2vntPm1fs2t9ZP1wlmL1lZV6L+qGqbFUlzB2G8oZo5aYE+/cGI14a6krWJ7dMre+b2xKPRpmESsNzoC2qhe2JhJjuCVf2NYXiTVg/stDnadCPCEqgu8l7kQSPfx2rz2r1RS8zuzMu5LOfN5m0iXMi3vTirv6EeFx7wT2v7Gg/Xvh0qPACJBM02c9LUIZPgFrwjI+DcmL1JyTxuFt7QYKy7hJ9KN0XXtgh46S2sKgGyv4YdtprXzhnq+6uj3Y2hHQ6jakiXt8iXrgQ67+jtw/M3IP8xt5wutLO8sjriW2ocerBs/f6PSaDVvWJC33Hh2qq+vY1W/s2u6rS5dhyVbLfZZ5R+1Ez2kWiTJsNmZyXmZGMtSZaoflkarriEecjNTP+OdMM8U7y9LXP2w1X6OuCspTmk1JquqbiEanGCT80J3EzSr49qChEPs6V3oI2F98EMM+wvJpTx13Ylp80mIz602qTr8wBwh7Sgz4Puer7G1z1Dq2KVf2NyaZjjQZfTaDV7Q+4FzpB9DyWP/Pf3QG/u7lluMmr0WqMZYhDNcw77KTKg9ajAbQHvYH7+g20jelFVcjGDKM42shsf7o+DhTxbcC/4ExAg88yu5EP7WB2Zaoi/Pm2mapt5zOOrQ7WkTtnTghcs2hgDAYxc675uLib2X0uIzIi/v06Gn1OPIU646P541RHYOrNvzKab5O/03j5tdet8tYAy+s/Irtn69v48xJU4Nh2XkIOC1RhMOTOSaSWn5JamjPnJFwPqJTIGLmSitzE2Mq7raCquOWbo/G2wq6ZG6+ANy9bAIcfYfkCOCmKr9hJo3azzRTq2NUUbLXpjFHx4cRA2h/eNLM5d6irvDbmF8Nep6eiY3ejP+m4pNd/vb3FV+0ztqf9cZ8x0ZR8MOze3BtvD5v5H3qc9rg7kWvwGg06l8XmZtWsI9paUdWTDoDjLFZ1lRuT3vA6l7Mtnsw1+tQq92dSLdZArCyVtgQqF46WQ9zgiznDotkt4tE8BrrMqn5P1mUzVMJO5gfID3q+m2yb8V70WGZV2HL9uPDJDFku9V6SPBnyCDTX+yLGzr5s0aelZMH0dyqz14EtkNriBeU0q4wVqUSoIpEKsX+vaCHrVmvULAuHp2vKy6trguX4+wz2u+i3anvpeunuizrLMdIqZb30GG3Iiq34rcpCbZ+anlXFCjm/SlCxLBwQrYm9C2xbLRoilq3SivXZj/QwuE3Ib3osdrzSJc665kjV8griy6CSxJCbYqbHpJIcJeuFTLFN0SXLhRiawmIhexduot1nFppbw9kquLDjdnvCIU/DgcZ1w/XOYtOZ1k3ZZN3C+SJ2BvjX3Zio3DDcKveGeYnM5H3ku5YKLzJjA23w6q7EjleYHeWzjrniWt/bV+iHXcaY7opUfH4TK3y0C/TTLuYllhdUGr3ZYTWDXjsV6D3hsMtdEw3bTSGnAPPC/7C6TYJKrdK7qwILX1rch2ywyqXhNWqTC3oRZp9nvqL6HGqg1vZJFA7GcC8sdrM+OBN7xKN/xD4Tf1Sg88tVslXiytvP/y3ZSegIzthjj0gee8auf0SyzwjxRyVhvrBAp+zbIhPHUru6yPZib4J8ZfoVtc5ZHjIf2DGk1+sNg2p5Vv0YXOk/JtZ4o2perWI5i9Ot16j5vfuYKLarH1CBZ83D4QPE6v6qvsHM623QuyD7PbCxZSgm7023hYL4l5zbQ5pQ+DJze0YviKGQ0TtrnEOzVOUYT9LrxnNnYW964TlVOLKEU86WqQVO9iLBP1jsRLLBMp8ZvMFnOF1Zhd8fdui4Z1UqrcVf5vTb1NwnWO4hVmPxqcpgJBrMxgWTBu8AAI+e+Y3BatBA/0BWC/vtduZzgkbN4b9wyz1N3u/okQFVKV8JHb+o1nJ4Z+OPr9JhelHLZchORe+PrxY9Ovo6hdmmvD5Z+Ap/VX5bsvA45s2LzGbVRxbzPk14TyzhPbEK7821ba018bbW+MJTqkhLvLqlFXhfQSyju/6PzGuqfWBbqlGErIeqIr5BSx9g/SO8+e+SKpIh19jI/ejF0qHMRQtvhZZ8ifx1AX8J7LcJVkbjCPt9YYfGpPVUBYPVbq3WXR0MVnm0zEnljQj3jMFmUKkB2N+3heI+vd4XD4XqPHq9pw5b6Pz1PPMVfj9pYSv9ptHJTiAROdi2S3pLDbR3CkFjLVcU83wJ38z48LdmXny/pNExLr1aoy8IZp/D6bOoGavaXun3VdgFrdZZGfBHXVqtK+oPVDq1TBP+9JaDA3vdYNGpVOAqvScGYm693h0LBKo8Op2nCtr8Me4Q+x9VJ0tR9UWzliygerWBoOrLkGuM6tWGRajK7RGW3HE62PvVFpfN5jarXbqykMsdKtMyCw8uupeKcg8osDJ/raQW6hffs1gQsqBD6HZ+Dz+EBGRGLhSEEZhELagTZdEWtBvtR4fRDDqNPsiQL5wy01uPSDuk1jN3r7+7ana+dl48MFE5ockNGAZQppfvtaTSZWnp7vmJgd50undgYv5uSfCP7HX7+0+cGjrVfec9ffc0HJ1unvbevq98n214l3MX296h7tDVJEyJU/dM79vVkUh07No3fc8pIXroYEUUJa8mr1rlJSx5Zf3GBwaXsN1KCWwfW99f+zJR5E56b7WJRMzhiqZ0Y0NMPtvls0s+K8+FJddLz0ufC87F15El/JX6uJdT6XTqPD6801jfWF+JUwstDfDvLxrr6xvZYXy85sU32PsLea/9ZSrd0FDJ1KfT9cy38MOFvfj4Ds59Hqe4T8IhBVcL/7Oxsf4ncME8AoldmNtdcGC+3pBsupaD1IVUKs2KcqYFARI/x8VeTafSCUhcv44+zv419xPVz8H2PkdWvLzglXxb9SboaDtd8dJ6L7MfeaKMM8HpcW5OWYPAM95XIXfpo8LnSsonhFzhcyW7XflaiXleCFW7ym167h2N2lAhlrnNWu6Fv+IgZHT5AnqVwL5lN+AvzNlvlLkNHE5du8hu1uGPlwxuB26j3Ga0Dh0gnlOdB/9S5DD+ZHbkCRRuguY8lXDpufIqnCqfs8oulPJxZL7Bkm8g7W9aKWfpd5FFX6owv4Xtpc4I7V2jXfmlA9xPBIvHYfeZhF8wWrPTbHGatMxrDCNY3A7sapXb+1yix6J+gfsbwebw2Pp1doOW/ZlK4OEfeIeZa1/j8JzOq3lI/1Xh/iteB7CwXvsNa7R5zWqVwWpc9FfgDRgJHzncdlsKULr+jPDv2ZTwO4itNHhiSzam6rmQI9THnrr274TfHSKlvvFvg5h7/1Xp+o2JPXOT9G1KXNMK9DAfXkIjS2h8EX2+SKpa1RdvltTpFej+G9LrNybhyVsjzUFK2tAKdAmT7gwmfWg5Gbw3pKcpGT9jOorJ/IDlkwpZNy6h7y4lG1pGmxfRr26e7GdWpzKdTH9b9vpSchxzdrv2uY4uJffQyuTx3hQ9hslb4/0vvqDfCjRO6D8AXacUOAj0UuCl8qb/ZzRefm6N1uhfgP6ulILr/w3Rx9dojf64Sfzh+6afLaVQ0xqt0Rqt0Rqt0RqtQM+s0Rqt0Rqt0Rqt0Rr9kdG312iN1miN1miN1miN1miN1miN1miN1miN1miN1miN1miN1miN/gjo1T92wr9whK1A+Pccwz/WQr4k4sjXYyZyhdMsMvGPyWkOVfL/TU7zJXlUyM3/nZxWl9wX0Cn+n+W0BtWo7pHTWiQK98lpHfvZQn492iX8uZw2oBrhXTltNKk1SjtNSHJWKV9MMRrneTnNIMH1aTnNIsH9D3KaQ273b+U0X5JHhQwevZxWl9wX0DqPS05rkMP5KTmtRRbPsJzWMVsL+fUo7jkopw3I4flTOW0UOM+fy2kTahb/M7SE4bXQOJtqVk5TnGma4kzTFGea5kvyUJxpWl1yn+JM0xRnmqY40zTFmaYpzjRNcaZpo8kt/lBOU5y/jETUgFKoHrVCapD8RfUTaAbNwc8hNA/3eshfoqd/j34M7kxBahol4EkXkoBENAz3DqMj8GyOXE3CeRJyn4LjBOQ0ohykDsKdSXQacmwBbpPAYwc6S1IiGgDOZ4HvSVKjBKnDpCUi/MyQv+V+olCHWGhzCjVCKlq4akG1pP4x4DALeUWodwzqwTzG0R1y3n64OgJ38dOT0L65Qn92kL8oP0dasFp7DhEcRNQN1wfhCb47RlBY3EfKZ0buqUhqOQlPx0l/FXRPQ9kT5M5JyDVBUBPh/hFybxBtgjZhdKZIuWmC6zpSfpLkmETHoE6M8gQ5inKLlLwiuT9HZDoFbVGkV+wHfj4PrZiCknOAQg/pzRTpyVShH2PwcwxK0BbS/oyROkRZ1lPAEXMdg3yY11m4Og2peSKHOejfQUhLpE0nCBa4v1NwPCwjRbnOkz7ROqdJj8ZJS6dJLXNETpuIVA7BHayPJwmCc4TvpCyLKdInisUc0Yo54Dom6yuW2Kx8X6nlGPCRCD6zciun4c4xUivlOUeQKrYA1zhL+kLHhoItbbtEtAZrwhFZc3GrjkHeMah/nlxNE1krek0xo7VQOU7L/Zoh2B4kOYstLu0RRu0MKUd7fQdcJ8jYLZVmjHA7RjicJTiclEdpKd6K9k3Lmoz7T+VygmiDoqOTRNZYc2cLvaFtPCznmYOrO2Xu89ALKqFTBSmNER3BI+DYon4plmccWjJG6h+X608Q63KYyAo/WW6v2pf1epesOYrmNwOXBrB3q2v6PKlzgmgiruWOggyKI3O5nTws6/VsITfWXCrxacg/SXTn/4691a1Z3P9vLO4AtGQcVZFRVi0/F1GWaMUMadk80CxodhLoNKEEsbKLNSch61sS0meJ/hwmGoTlchbu4jF0iLQF681irhJpA25BMYfCbyUdnSN6Pkv6TlFQymGp3kaQp5bmLEGaIjNfkLaSW7EL47LtxqO8lmCA883KWlFqp2cJrtOyfaBcJuXrMdkmTxKLMkV6SFt3kLRDkfJSic3LJaj+nFh251ChD7U3ZQnorDBBMJ2XZx86Pmm9tYV6lvaAWtHTBKdxMp5Wwuy03NMpMtIkMqboyF+OPS5DZ5YqyF+9SINX5k7b8H6xLR0fdHYX5fl5nkhufNE8ubQHxVlxabvWlegA7gntC/UWFFt5ouB5TJC5d5rYkbFVe0p1b2yRVlF7MCMfaa9o+iQZL9Q+TZB5bEq2LZQPzikR67+6jlIrPi1LpshdGSFTJV7FEWLvpmScsVU3Ens5KfdB8TAUlBdrdS2RzBhJTyDFv1pq55aOhKoldmGS2OnTxKOYItLHUh2Dexihw8Qe0WdJmef+JbazWh69RWtR9AaU1tzK7HSTs4HoX8JjQOEhBgrafBTuUTkpWkO9E0meRYrafaMZTtHK1Wc5LLmthZEzV+KLUHlTLZiU66JWe1qWey3p8wl59lH8CuoXHZblrOgx1atZ2d+hNcwQv3uM9FPRlDFUnOWX2rN/BVkUEBojfce4Tcm2fkIeq+Oyrz1N2lo6Z04Rb3yO6KbcxtVlC+nti+d5kHZ1CUYTJRFC6Xi4aX6oGNUouVe2brVLrJuC/dLSEokKppb0W2lX0QcrjpriTKTIsBYp0RmOwpTryRINmSXxl0T07UjJDEtbfZC0ZVKeqU4WZFlqS6gMk7LE58gokQptUMb1Yl26eVRLZ3jay9KZZrFOF5E4TXA89j7lqMwGJ0l0SZGZLGnBBDniOou4HIUc4yVzx/wN7DG1/BOkB8qM177Iio8BxxlicVb2uqfJHKHMMqXxmTJPrGRTFpeaI7aCyuqg3O+V59yxVSR6otD7OaKl04Q7HUXLI9/3qwHK/JZDG8nTLagPrnbDbDlM7myCeyJY0WF4sguueuFuL9yJQY7t8vMYkdRuMg/lIN9OMsdRHsNwHILr24iN60MiucZXmyH/EPDCZTeiEVLHRuC2neQcJrwH4e4AnDfK+XCJHrizE65xOkusIK1vCErRGGKTPCfSlu6A+2Khh4tbtYnUqLRsEK6GgX9OftoFvDcRfrj9uP4+kh4qtLNPbmkXwQhzxjx7oEUD5Arf3QnnrZBvO6m/i/SZtnaI9KEPntO+bCQtwDUn5L7SfBifXfITLCPcvgGgYq+6CAY50poifj1w3gotx/yz8HQHmSG2QMle0tPtBL2NMma4twPkqtgrKqke0huMKsagF9KD8JMtYDdMjrQtwyXcFmO3mzwv5qL965KPPQS5LeSKSqOHXO0gssJPa2VZDpN+LK11N9HEjSRXF+nx9oKG9BHtpa1XtJPWsaWkJbQ+LNvStihaLd5gjFAuyvOdsqSX44JR7yKY4HZtL9S8Gmc8Nv+lotBifJkk9gevGNKVtwTxD2bRmS+LDan6VnFwavzEzNzMoXmxZ+bE7MyJsfmpmemE2CVJ4vDU4SPzc+Lw5NzkiVOTEwljbvLgicnT4pbZyekdZ2cnxYGxszMn50Vp5vDUuDg+M3v2BC4hYs6pRjGKTy214vCYNHtEzI1Nj8+M3wF3+2eOTIu5kxP/p73vgGoqW8PNCSGEBAQFLAhyKAoIhBOKgArSAkRpUsQOIQkQIcUkVFFDRERBQQdpFsA6dhEdHRFFEUVx7AVl7F3B7oj9/ScBxBlnrvetNeu+t5Z7C8lu31/2X87JPhEpTicigS9Fk3rixIkkqDc/NonPYSehnRRhjgiIolJRsoTDQ3F2U9kSHpos5PIkqCyBhwaxItBAPocnlPJGoFIeD+UJYnlcLo+LJql6US5PypHwxbh4ShpcnozNT5LSfdhJ/FgJH6fBRgUiAAQ6bKEUUCT8ODSOLeAnpaOpfFkCKk2OlSXxUIkI6PKF8cAUTJXxBLBSyAUFSIQ8iZSOsmRoHI8tS5bwpKiEB1LwZUCDI7VFpQI26JXDFsN7fIkgOUnGFwOkMFnAk8BMKU+mBJCiYokIdgPnFtCTkkSpaAIoF+ULxGyODOULURmua+AMloCMQqAlikNj+fFKYBUhGS9NBov5iTw62immpRQVsIXpKCcZtlTFN64+IShZwgZZJHwprlEeW4Ami3EygBgPPVJ+BkyXiUCgFFwkNgobIFDRwo2Hk8CWAGM8CT2MF5+cxJZ029XwLtLDcXtwHgcqwrdgGN2B8ZXqZRI2lydgSxJxOZRb2m2Z8aBxMd7NEYH4Qj5PSg9M5lixpdawi6i/RCSSJchk4uH29qmpqXRB1zo6TLeXpYtF8RK2OCHdniOLEwll0s6pSckctlTZgc/7QkyaLBYn8cFw8DE6OkGUDBpLR5PBhGS4seLduCI4sLUyni3K5UvFYMCqDRVL+DDKgSk8eGXDNvIkAr5MBnCx6UqpuswRVAV2I5J0vYnDKdj+VXawA24yR2aLm2MKrLXF13QRgP1JTeBzEnpwlgpE+UJOUjLY/hfuRUKwFCu+tcotekwHhH/iVuVFYOuw71KZhM9RGWQXAaUddmGNUGrAig9UwCfwUCLBPYcrShUmidjcr7XHVqkKLAvEge3D3yTLxBAFuDxcTHxOAi9J/LVGIS6B7aqm4xvCV/pJAj+WL8Pjk3YEsBwnwr0FZ7lT1bZoLFsKvIqE3ZGiaxOsOm2BJ6Sn8hP5Yh6Xz6aLJPH2eMseZkZ3xhRr2F6lWSh9AIf5dhD8VvA62zkjEJ9xDlfzNBHIhKsGfCkJAptS3V+HSVyVXwVKbe1QfHOkSucBuUEFPFgFpg2a4dqicRIIeriLgCPGg8y4jkFXsKOwHBXFQrAT4kphKwN1l519vxQ4Q2ypVMThs3H74Io4ELKEMrYqnvKTQDNWOOJX0qLhnZH6nLWSI64yGqr24ZvzlHEW7+5hbrad5oZz3zWcxAc7VdHGsSSqTAUUlE6ES2iLx3J+HP7KUypEnAwCSROUDgvQscm480rxzk4rAQntQXApDw/RIjFfFVH/llWVwwNJldN0alrJRGqCSPAPMuJukCwRAjM8JQBXBDFUycs0HkfWZWBf7BiMn8tXOt5wlYmzY0UpvB4JVyiS4S6jCub8TjdWWUrnkDQBzwexvK88l91DUAlOXioDY+LDFnVnnn9SAO5vAUw0PMQvIsorjImywtHQsJBxLF+mL2rpFQ5tS1s0ihUREBIZgcKMMK/giAloiB/qFTwBHcMK9rVFmeNDw5jh4WhIGMoKCg1kMaGPFewTGOnLCvZHvWFdcAjkdRZ4IoBGhKA4wU4oFjMcBwtihvkEQNPLmxXIiphgi/qxIoJxTD8A9UJDvcIiWD6RgV5haGhkWGhIOBPI+wJsMCvYLwyoMIOYwRGQcoOhD2WOgwYaHuAVGKgk5RUJ3Icp+fMJCZ0QxvIPiEADQgJ9mdDpzQTOvLwDmSpSIJRPoBcryBb19Qry8mcqV4UASphyWid3UQFMZRfQ84J/PhGskGBcDJ+Q4IgwaNqClGER3UujWOFMW9QrjBWOK8QvLATgcXXCihAlCKwLZqpQcFWjX+0ITMHbkeHML7z4Mr0CASscX9xzMl37e1KoMl/ac3lxbLhyobOl4rQfBxc/Di7+C93+OLj49w4uqMqfH4cX/38eXqh278cBxo8DjB8HGD8OMP4czX8cYnx9iNGlnR8HGT8OMn4cZPy/d5BB7foOBJTP/Qk5hG8VYue3BgiIFbxGKL998E/FV61ESwuBOUjm987X1lbOP/2983V08PlEi++dr6urnJ/2vfN791bOP/G98/X0YD68EvBvUZCU80nwowObQoAgqo0QCYaIIWEwMojgAFp0R0IJo5EphCgE0jySQpiO5BMykXLCPKSe8JPaaMJKQNoEK2v+hLm7B6YBYJoBph1gjgBMP8CMAEw2YAoBMxMw5wHmEsCsAMyNgLQHVtZ/jYmk9sDsB5h0wBwOmCzAjARMLmBKATMLMAsBczlg/gyYvwDmIUA6AyuvfI1JHNsDcwBgOgCmB2AGA+ZEwJwGmOmAOQ8wSwBzNWBuA8w6wDwGSPh3dW59janm2ANzIGAOA0wfwIwATDZgSgBTAZiLAXMVYG4DzH2A2QyYLYD0EFa++BqTNLgHpjFgDgfMAMCcCJgJgJkBmHmAuQIwtwFmHWA2A2YrYL5QK0Fgj5FeuH9QKAiF2tCwFkpZGUWDQNFQKHx9rax0dcnqCFnjGSUtNzeNoo5QNCj4W2go+8W5HXJ5GoVEoJAwz2eeeIFJZHJaYWGMXJz7jIIgFJKcIFcWVaOzKJdvb8KhyGoImXRD2atBImiQVEAYWZ1AVs/NDQ1F0R4rCXI1NYSiXllZSdFEKLSD8oPyVVCLoOZC/TvWNdURTWC9i3cS8BhT+EwuF2uSCJrA+39kXhNBNLuZ/4p7wFLfXq8UENeDZw/2ySr2e65V8q+J869JRTS16qFUeVZ5LlHWfKiamgRNTXymF4Q5M6j6UCkEDXVEA9QNApQmUMkIlUIikWT52dnZ+TINMqJBScvO/iCXZ1JJBKp6tzieMFNDIxO4FMthQpqKkU6J5FQEoX4RSa6E2XM4Gy8aJESjUyg5riH1LkRMyQcuFshFRYhU9W655CQSQiUXQqHSEKp2fUx9DEhZuRhdjC6Amg2VqkmgfkM2kE4lAikTxKGREfxPy39TPBqJQMPF65ZPA8ZmwbQ0eaZCkfm1fDQEofWQ7/9CQBpCpHUJ2CkhTSkhTRuh6dT3r+9faVVpVRhQGIBbwlzKXIqCQqMSaFS5p9wT/slNCXjF/yiSFlQKGaGopASxtDQQLU0ilOF+Cih+w5Wjrr64nL6uWuoELXXXL4J60jRgtFtSRaZq87pElUO60uopKzgCQtHcc1ihLBQSQiF3SiunqsM2eXp2qHBdcY+hdHmMFkLUIsu/llhLA5dYqxeipXvD6IbRs5GnbVuSWpKaAk+cOJx/NL9Bq0FLi0bQouEbHoP/qmfIGfKBBLz2gqqpgWhqZh4hk2cdOXIyRZuCaFPVoIyIb8BL/AhNCoyPjDty5FN9fexIbTKiTR4ZExPTEdNZtPDx2UegZNbPghWztImINqm+HjJBV+ns6VFwUOrv9xpURen9LTc6x2jqsItfCLgqPQ4PJBwCXodBNYKqTSRqk78gAjV14I1yAi+EHjkVv6YgcpOE8Z3vjaSq93hUNvKSsGNtUZ90SZIt6i/hJdoqz7ls0UC2TPhPY0p8REkDfoxXwqu+ipxxMaYwXkLWHJoTkPNGG9EgViqM50DXbCKCMGiYJlndppca0VCdgLHJVBsyQkIULkSEVBmOjcVse/QYrRokNyKMVNYQ5Z2USPnZBn7n7YFXzLQHGEn/cvDBPrspbcvdY8ZFtqeMt3p4hKWoVPSPwBSkQ5hCbWOlGhEhEvXwLFf7S6rF9NEoXLLhpRbT7uYWUQe+UpVsqkWSyHrEyHCGHtYbb1D0qFFsaQJfGC8TCRm6WC+8U0NPI4zHFYiEXMYgzAjvoeoZfPNREoYpZoKPq+n1/zIewRfw7MJlbIEYDfXxwgb102YMw9wwF4aLs6uTy0RouvZoYlk7/hXOtDAqPk7TU/MK8WFYYoNVrUFCH74YP2H2DWeizPDg4Zgv09XOwdfH2c7Rx8uNMRgzVwlk9E2BwlXn9JgCMeupYESdoKZAdAjQTyUq4KJuz8u7Li8OPfds3efaLl4xKs765tO3n283rj9nkPn89dj0V4oDFR3NB7Kapl6nS+2O5+ufuFPyTod1umiR6Wjb21tnrR2xZdrbaKu4If1zXHu3VtjMaVAzq3nIPTH6wcM5Z66KfxmjMSmK3DqOOqf0xvzzf+RwkXVmH6m/7J5+xG3x451Lpi6auTihQN541k6TOTasObROvrrD5Jpscu5dtTirII6MfvOw8Rz7eve44YVDL18Qu5dmNN6OXxut/2nV/RlDPpq/2sj5POKXI94VWf7txs/PuFIv3xGv5V2vjzsvipg91uFqq1/hu6Q9zkl9dqROHdhuX51v2G+haZrx2tURN0uNNrlhcX3y9Ihq4EarFYgmaEQdMwaVGvci9SXpF/y+MPqJh//Bsie7HW4cjbdIPjl0jNKEjM1J/bG+cn1zp47LYX5iarvn+5T3NTbbG5xrdLAIfIIJKQgbg7Eq/SuZOT6dx1kcSdKfjrPEiXy8177zyQqpffc24ruo3EQwSjpMwcaTKeCX6uoaCEIKxEZjAV1tjJgz8m/Py5QEeJJ/QJZheji/g0m4CXZCqlH+5I9quJWID4308XnuNek5D309a4TjHo+l/d4VxDmUFVzIC3ZezXNf88fkI8df5T35UGf5a3xTvd6WX39dd0U+84qlixUtYcDOO8cem3XoDFbse6P1k7nFrtq6xNX7PvWeeMR9VVnuqOJ9s/uM/7xoQpH27JXRugfs4grKL2bduxZJ8KMn+l/NcKO13mQd0v196ZxDJuWP4g8t95fEImPjBIGV9KGJJR9PkVs9qJaNVVvvmY90LvWSJPosm+HRd+KlMysLb29ZQBn0yjsXSZgQWoa9fnvdT5BrMBOdeK6GmRw011j2Krt8es301NH6wuzxg/jT6qedPLV11FX0qtvtGR4jmusn/JTzqJ/ZicSFhA+umIKMQBR72COKHX44vyMjK/ThZ2UUO9xTazSIYrP+lVhhhQ1ROb1Jz3EuDw3nxyufq4CNxR+oYyiDmQvmymA4YFCdVMHsSxOT/Sv8dY6r/c34f4xGuQv2WDRoFJTL0w0+DIn5IMm1ffdqdUlusd/u1c3R8+2HO9IHLU57l7nBRIHsymg23Kd23O9xY9mb9yTjF3Opn82EVS/i3Rst+9+1MnlNKvLitN3ea5DfrlfufM1VHCEa0baFqYmxDu4vwMq0mlOOvZEu7Zt6Jq+26ChlLto+6Gfn59MP3ZARxiw4+/vixxfTPi18tyUm173uV5OtsSUHGrOrC7de3GZzLuK985Xfpi+5N+hz2/TE5tmUFNkN3bEB558TmgICV2s4352g/TFzedO9ibfnvr5YrmOyaN2d7H4HLx6vMEaOfgxYr7fEscQ0wKHjkMUqwo794cfnCK0nZT11Fcpf1rbp0R53RSM5aCRTFW4G4+GmOzEHUpBuT1XrEa6aL8Zmn4pxe/Q5/tDks021m3Y36JViYfhwbxLEojX+GJOhjdFUqYUUFBIaxnDCHPCmup6NgyOGMRxsOK6YU6wzj23n5BbrZOfk4Ohq5+o4zMGO6+rMiGM7ODg7xXG+CoEBQu7dUPVzio39XFzMdgl+Pp5MXPr3IfCbEUokliqjIJgL2DFYMRgwbr/R+C87zMUOc1WGQHaPEBiJwcVKjxDI/I8EuqLgP5CQYVo443oI8plExAh/cmc1BREhkPuatEYdCm0yD1k1Nu1Se8fH3+ou1D9/O3Bce3gT31/9wuHmtlsfyiYtje7talWvztS7UZ6euy9uU2vtY2Kk+W538zQvwdaO54SJRWULjE5oLj1dbuSLbVjb9+he/0mvbZzyKgrGuzQEG20zO677W4tCd4Pzs61mTQUW67Lyrlsa3Ykznu9B/xylFnRQOKfS4fHOGvvQcVPI1Qb5Tcac3VKt2xczhugMLWaud5jjUewRxUo1n/+pWvfogrsUg7GNNhMZk9ymFf+8Jjex2Er0/PDWR3XMfidig7N2RRj6LypdK6gXWh7psDRpakc30Kqfn6SVF92atoI/p2rYJQH6ae6Fzw17SoZpfnLXP1iqv6E+58RTxcFNkRY+/XcFzE3LOf327IpRAy7rz7+/sCLBIjdhxIaj8uAh9ymmgZyPy38yCHLcNS4m5NLoX10XfaZfrY5e45N4LO1UdW1iwZykeZKNj9a+r7hqeNHtA/eYwINyN3NO9ZZ9q/fOOFU8bk3G+OY+/rFnTZ9+GHmYQXtj78Fd6yKKCR2127cwpJKWt3/W+D+Oxs9jt64sPdyU3yzyv1lPL2qv/mM7Jmibxvr5YXFKUx3l8KcRr7dKXcg7xp0acL72ddHxeUYv5NOQkF8GZklrzk0yGzV8fP/ruU/iD7PW2/8+OM996uk2J9/FxvsWa6UoPJ4ebrGrIhEXBbx9epV4Sm0VJAENSAJPVUmAyu6b4KSM/UZ/voKNVoZTquaSIfN/emHLRQb0VQNrZAzA+n3VqdltrGCGNqq4afElboaJRBA8wXT5cXwOW8ZDvZJlCSIJX5aOB3fMBXPCHBkOzo6YGwR3B4ay6Yjhzf/dJfR/iu8VVUnV11sDlgzNTKQPuFl363Zj2Vjz0C0nr/YPttB5cmb9mcAtMgzt/VjjQsRSA1bRQO8lW0snY0OuEBIfzKhrm6+h86YXqfTZ/BMmzY4W81a8eBVvZPthxv1c40f3g1dXHTQPP77wHfOU5ump205v9yatersu6af4S1a/+4Vvzzl918qPbrk5JyQyTOuOmu37aYWFmHDeywnYinezLpbUPDAtmdVxVu8lZXe4IGwns7AigDDaP663pXXczyV3zpGzRq96m72+t7++pqIiuz0y7RNSbhxKmUvQxfzad18z96s9bBdRsW1Qmhcj9cSy6yPm/FTFJu4y1q7+8GbZDuSk2ZiIz2/VGw6htK74vgk0sh7T6Y446pgavPSI59+8usTDt7EOiQT2l4PpkjU7c4IBgvcQsKxSVWzOKsSyFsr1e21WxHiOsyy5O1jvw9Cb1PClE+6sqeKsYf/r5qnQTd/St2p05dotgdLxrzT06DwsVJUUWBjkoUqfSq+cUd9/Xdw9jD9gjYdyZUKI6JEQAjA/zLdHQnD9b66JcTl8VKjfeT0MutYtWdAwWc132NWHO7ektp5MHxuEVNNl0ycJtPQ2ndw/o2AP/XyfVfmC2D1RxOZgVC+07GqG562o2m3jy41uGiM5m2vTXuSdbhuBPLm1v4Cq3rQw4NazcIOrIZuW3Lm/cNoF+cF7RS/I9nPVHi4eamEmfv/HhztpZXTtNxq3xPv6B69YlEiVLN1T5bY83q5xbK9HsZNH9S3NQ0fd0jB0eHuCMTqF4W4joTU9Ert/nkvVu36Iyl707NKefo+D82Y3OttMXX3g8b6ZNO8Z58Mlpk+w47VpvMmTkH5U/V5nr+iXvh75a9z4Gjv7+2/n5pwYO+7BCnFR0ma3wPN/pB/Y2D8j1vrpqmXWTuRUw9hj7oMEJopntKO2tad8au6+bZu56/aan2XOe4Ibp5v3GZJCGxmWP32in4/+vpqa7UHxTRXen+XppvKVBljcA+8+Uw2bVpqZnvZ5aPOw9lXACdvzLQ7ywCFDAyyiJz4a93TdtbIVx4eL6rIsZeTeT1JMDyxTHLSM+KV6mvv8qhT2TmGV3roDG/2f9RF9XOCQtOPT9bFN+ebH4upWGM/rwyW6222bULDnjundXduPc3amRaif96KHbi7avjZtU01lcbLh5SXz9JLN7B1+pggrJ+UPPlD5NPu46cXHg0KOlT9h3XiD8ETzaTOb+E33hI/Wl5xkWH/u1ThpckvQwKqWd/YrR9Ej+yYe01v9EVNoZGAK9diuVNCr8KwyFaj9+TYgK/dfCcUOGKZySOvvccgvdwQMSBuuDpizmyppDFM2GRje/J/fsSiIf80dRDx3ECF3gM9tevZOomtE39Ii3KjQDXLa++KX8aYV3gOHJj6cGLpxD9nVkMTaO7tBa9BVl8QjfVpoz1wPlZG3N7ldQPQZ3ufma6dz580qirFI2raStfxhwtSz15eF76DaNmy7vMFma4bmtkvFE47HGKo/jEt54BA2pI/9/U2U0FM1vruntBymqyVvSnjZLHg5fHJV31d+e2+4cjcLuc5p6yo5OnbnPH/quH1NQ/vC5PS1LOv72vsr9VL3F7k/fX/bZqKuSdA4q1UZkht9hu9mTW1pb/dZPOfyjB0zcgZe9qjOn/Jgfki24Ysq+wl3CkfYbXUc37jb45PDuRo19+od25a4zjq7Qm77OnjcYlPnwQ1uQu7s8L3LdbYMMM9ufrVXLWfhm+hnp8MO5BfN21dvKhsc3d/qlxOWVq6DS91GDzuVWb1kq5H5+g1xbWyTaTetWCuic28NnnLOdIxH2OFdUaMs1J6dyZhkf8H8tniKzli/1JoOws19m4mK6NZ6g5q6gecjx9x3q9J5aM7a13+PbybzzsEGScYNyX2L6wf8yhqfHjKKap2zsC2Iha3ftOh626SKbR+ubo+7dbAka0b7xfYx91nW6/Ws1q2fGS+/tyA2LXqHffalqOWTD6RaWT1vFzRYFdgWeLqEHLw513f+Yc3AxvNrfexlS98IO9LQ8bZ6U2KWlnuEOGZf2Z7b79rK4FfF2/f5VSaVnr1xMTe/O3e2Q+58+I309yV5fvO+ZED3An0iSWsQlRCufELEh+D1dV79S1LueccjsRtOZBT6/KqvHnzz0fqjjDPm852wiarkhn+CGlIZVDkmh/VffegDfgteC87afVMSjTlGOzgo09zUHmkuDAvFgnukOe/vS3P/gC/Dsipw5lFSVgmWVYRlLe5WEl0Ny5qDjeoiR0T6Ov6n2yyuiCMFyfgCtiSdI5bSE2QCzLMbgIg5DXJAjQmBBPz/dMIfxolWPoyjengrHVrSzsfKeN0P19FR42/diMW/yFlbeiMi3ZB+rkUWb7aMVtz7JmdJmXfxzLPpWoUHedF0W4+OBskZwZxP+0c9oB4fccB/w+qX/FbOATPntSVTeNmFM/P8QiNbtJZknjUcY/RypHde2OntHxNve2jQrZfdcx+49vwu49Qit1sPucd83dMyzF/qzVxXKJuz8FXzEKLf0EMLdGvXbFDXWtae8C6BvrRy6KihieNZHBNNvnBiafGdOa/qC1762Vz7MOJ0nfNT4eCtd7dZtp+++rLXtjKrktKgXu60F5T5F00aHPrfetZod3LSyp0sN+oR6qEjW7be3XG51SB3LHO8q8N0S8PZ1a8sO67ZDkf5pTsmzE8QitbvljV4qpPXIUOtPBSj9ILiaPU1Qa9vFsw2EhnMZK5Pues5lLe6YUpYbE6DMWdYSc71Ky87XvStKre8+dvaktNPpnC8bk/SWD7Pg5xKPkOuTjbR389m73r2+5GBpP3XvY72snpyjWffVvJH1eTiFsLFKr+6CS9L1mqOCdAtk5ucJlg3Vi9bO4qZOsj5yNlVqyoyMszeBSw12fTe31z+emXHgcTdY0puPU5OM2x75FKW3n/M54s15gnJ97a9+5D3mCZ/xB+x7QPWTgpcdP16soCz2P3MinHBIQfkUWZVab0dTDOeelGrR73/+cSaKQercpdFTR8XHMCs9z62LGUSVR6Q+DG94mCdQDDtWJhUTzsj9DeGgrQdU5A2ExEEy1r6v05c3/448MvZSGXWYTz4dBqxphpDq+fBC3DxpUVj9MJ6jhpg5l8WkhgQ2lhPLrjkRxH02mnFbeJIp1Ds1LMWjNtjiRZjHBZROVRu9c1n/iP++jXdqiFyi7/17Iju71ygf8rNJAVCSLEs20FcvbMiNnNCwJkH7XuyXxhOqlv6kpB3c97zq3UDWiY+TRTv4ef77CQdHOKPlTEIf3zwxiRNDZRkXsew5YS+V0jkK+NrxU/XM7dV/Na48bfJ+RsdPRrri+vjSikvo9u2LAvlkmvZ78YM8X/vk0V7kj9aIPvDf+rV0WmrD0jrHNrGMPvF6/OWvAyhuI4feHxHxY3C683Hd594smLxosf1w8v1H4RTPra8abGpddAoyexzOXxzWtiymMVHfmOLQu4O6ED9I8s/G999f3XKhYc6szPnsrzNQ7KneC/K6kg4bcsuIIzZvMRxGDugcVn9hbReWnnWUZMm7l22ncwcaCPZF1x8qjHg7YsqBdEKLk8svuwRmaEgGkBXb6VpLvqf3Yh/+6Cth01Owfr3NEnalwNDBIh3j6gzdJQfHDMcnBguDi5OrhP/YpEpNJ1xeZzkNLqB/bwZe/m7CvcMG/6nWybcVgy1vPrkHRh5lx6QU1By4X54jO51N8qODYf3O7YHC+ULLPbyrtUbvLfKK7e+NNBI+372kogaIm2A4IbxtQMSjdW3fjP9nTehyCvziF3sNLc7M968ahW23qsqKlyX9+LyPp+4uA+CnWznM7qVxypb3a6fq20jLV+z5YTNroRVfV7Ef4xdqVgzn6R21odxGjsbNNMkOO/R5BvlC0pTLBQTE+20tsjC3azXhB97tma7aFFrx8qy5x+Yz/c/PTfTsM5ySNT+p8lT5fyLr4yLRTN7fbSlzdtVqjUhad/ImPiK1vPTX80aWz/S5mLB/NzjqTEd8T61Xuqeia3P07IM+M3Wja3W9ZesC8r9Xk/PIRD+D1YzoosNCmVuZHN0cmVhbQ0KZW5kb2JqDQoyMCAwIG9iag0KPDwvVHlwZS9NZXRhZGF0YS9TdWJ0eXBlL1hNTC9MZW5ndGggMzA4ND4+DQpzdHJlYW0NCjw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+PHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iMy4xLTcwMSI+CjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiICB4bWxuczpwZGY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vcGRmLzEuMy8iPgo8cGRmOlByb2R1Y2VyPk1pY3Jvc29mdMKuIFdvcmQgZm9yIE9mZmljZSAzNjU8L3BkZjpQcm9kdWNlcj48L3JkZjpEZXNjcmlwdGlvbj4KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyI+CjxkYzpjcmVhdG9yPjxyZGY6U2VxPjxyZGY6bGk+RGFuaWVsIFN0b3Jlbmc8L3JkZjpsaT48L3JkZjpTZXE+PC9kYzpjcmVhdG9yPjwvcmRmOkRlc2NyaXB0aW9uPgo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIj4KPHhtcDpDcmVhdG9yVG9vbD5NaWNyb3NvZnTCriBXb3JkIGZvciBPZmZpY2UgMzY1PC94bXA6Q3JlYXRvclRvb2w+PHhtcDpDcmVhdGVEYXRlPjIwMTktMDItMDdUMTQ6MTI6NDErMDE6MDA8L3htcDpDcmVhdGVEYXRlPjx4bXA6TW9kaWZ5RGF0ZT4yMDE5LTAyLTA3VDE0OjEyOjQxKzAxOjAwPC94bXA6TW9kaWZ5RGF0ZT48L3JkZjpEZXNjcmlwdGlvbj4KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIj4KPHhtcE1NOkRvY3VtZW50SUQ+dXVpZDo1MEIzNkU5MC0xNUJELTQ1NkYtOUM4NS02MkRGOUFCRTA0OTU8L3htcE1NOkRvY3VtZW50SUQ+PHhtcE1NOkluc3RhbmNlSUQ+dXVpZDo1MEIzNkU5MC0xNUJELTQ1NkYtOUM4NS02MkRGOUFCRTA0OTU8L3htcE1NOkluc3RhbmNlSUQ+PC9yZGY6RGVzY3JpcHRpb24+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo8L3JkZjpSREY+PC94OnhtcG1ldGE+PD94cGFja2V0IGVuZD0idyI/Pg0KZW5kc3RyZWFtDQplbmRvYmoNCjIxIDAgb2JqDQo8PC9EaXNwbGF5RG9jVGl0bGUgdHJ1ZT4+DQplbmRvYmoNCjIyIDAgb2JqDQo8PC9UeXBlL1hSZWYvU2l6ZSAyMi9XWyAxIDQgMl0gL1Jvb3QgMSAwIFIvSW5mbyA5IDAgUi9JRFs8OTA2RUIzNTBCRDE1NkY0NTlDODU2MkRGOUFCRTA0OTU+PDkwNkVCMzUwQkQxNTZGNDU5Qzg1NjJERjlBQkUwNDk1Pl0gL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGggODY+Pg0Kc3RyZWFtDQp4nC3LvQFAQBBE4blfUhm5FhWggMtVIKUElYhkChCeNWOD/ZJ5gF2tzn4HfKziJO4moRcHiZu4SBoAz9yLIKJIwol/ma3LI/NmJ20h00LmB3gBx0QLug0KZW5kc3RyZWFtDQplbmRvYmoNCnhyZWYNCjAgMjMNCjAwMDAwMDAwMTAgNjU1MzUgZg0KMDAwMDAwMDAxNyAwMDAwMCBuDQowMDAwMDAwMTY2IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDQ5MSAwMDAwMCBuDQowMDAwMDAwNzkyIDAwMDAwIG4NCjAwMDAwMDA5NjAgMDAwMDAgbg0KMDAwMDAwMTE5OSAwMDAwMCBuDQowMDAwMDAxMjUyIDAwMDAwIG4NCjAwMDAwMDEzMDUgMDAwMDAgbg0KMDAwMDAwMDAxMSA2NTUzNSBmDQowMDAwMDAwMDEyIDY1NTM1IGYNCjAwMDAwMDAwMTMgNjU1MzUgZg0KMDAwMDAwMDAxNCA2NTUzNSBmDQowMDAwMDAwMDE1IDY1NTM1IGYNCjAwMDAwMDAwMTYgNjU1MzUgZg0KMDAwMDAwMDAxNyA2NTUzNSBmDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDE5NjggMDAwMDAgbg0KMDAwMDAwMjE4OSAwMDAwMCBuDQowMDAwMDMwMTA0IDAwMDAwIG4NCjAwMDAwMzMyNzEgMDAwMDAgbg0KMDAwMDAzMzMxNiAwMDAwMCBuDQp0cmFpbGVyDQo8PC9TaXplIDIzL1Jvb3QgMSAwIFIvSW5mbyA5IDAgUi9JRFs8OTA2RUIzNTBCRDE1NkY0NTlDODU2MkRGOUFCRTA0OTU+PDkwNkVCMzUwQkQxNTZGNDU5Qzg1NjJERjlBQkUwNDk1Pl0gPj4NCnN0YXJ0eHJlZg0KMzM2MDENCiUlRU9GDQp4cmVmDQowIDANCnRyYWlsZXINCjw8L1NpemUgMjMvUm9vdCAxIDAgUi9JbmZvIDkgMCBSL0lEWzw5MDZFQjM1MEJEMTU2RjQ1OUM4NTYyREY5QUJFMDQ5NT48OTA2RUIzNTBCRDE1NkY0NTlDODU2MkRGOUFCRTA0OTU+XSAvUHJldiAzMzYwMS9YUmVmU3RtIDMzMzE2Pj4NCnN0YXJ0eHJlZg0KMzQyMTcNCiUlRU9G"
},
"depositAmount": 27000.0,
"paymentDeadline": "2020-04-05T11:47:45.2547812+00:00"
},
"rentObject": {
"address": "Kanalveien 109",
"postalCode": "5068",
"city": "Bergen",
"country": "NO"
},
"contactDetails": {
"email": "test@test.com"
}
}
},
"Tenant": {
"required": [
"externalId",
"info",
"flow"
],
"type": "object",
"properties": {
"externalId": {
"description": "Your reference for the Tenant.",
"maxLength": 255,
"minLength": 4,
"type": "string"
},
"aml": {
"description": "If AML is required",
"type": "boolean"
},
"info": {
"$ref": "#/definitions/TenantInfo"
},
"ui": {
"$ref": "#/definitions/depositUI"
},
"flow": {
"description": "Defines the flow to use.",
"enum": [
"redirect",
"iframe"
],
"type": "string"
},
"iframeSettings": {
"$ref": "#/definitions/IFrameSettings"
},
"redirectSettings": {
"$ref": "#/definitions/depositRedirectSettings"
}
}
},
"LandlordRequest": {
"description": "Landlord information.",
"required": [
"name",
"address",
"nationality"
],
"type": "object",
"properties": {
"name": {
"description": "Full name of the landlord",
"maxLength": 100,
"minLength": 4,
"type": "string"
},
"organizationNumber": {
"description": "Optional organization number. Either this or `ssn` must be set.",
"maxLength": 9,
"minLength": 9,
"type": "string"
},
"address": {
"$ref": "#/definitions/Address"
},
"ssn": {
"description": "Optional Social security number.",
"maxLength": 11,
"minLength": 11,
"type": "string"
},
"nationality": {
"description": "Nationality",
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string"
},
"representativeSignature": {
"$ref": "#/definitions/LandlordSignOptions"
}
}
},
"ContractRequest": {
"description": "Contract information.",
"required": [
"dataToSign"
],
"type": "object",
"properties": {
"dataToSign": {
"$ref": "#/definitions/depositDataToSign"
},
"monthlyRent": {
"format": "double",
"description": "Monthly rent for the contract",
"type": "number"
},
"depositFactor": {
"format": "double",
"description": "Deposit factor. The deposit amount is calculated as `monthlyRent * depositFactor`",
"type": "number"
},
"depositAmount": {
"format": "double",
"description": "Deposit amount. If this is specified `monthlyRent` and `depositFactor` will be ignored.",
"type": "number"
},
"paymentDeadline": {
"format": "date-time",
"description": "Optional payment deadline. Will be used to inform the tenant about payment deadlines. Default/maximum 45 days",
"type": "string"
},
"from": {
"format": "date-time",
"type": "string"
},
"to": {
"format": "date-time",
"type": "string"
}
}
},
"LandlordSignOptions": {
"description": "Optional sign options for the landlord. Specify this if a manual signature is required from the landlord or a representative.",
"required": [
"flow"
],
"type": "object",
"properties": {
"ui": {
"$ref": "#/definitions/depositUI"
},
"flow": {
"description": "Defines the flow to use.",
"enum": [
"redirect",
"iframe"
],
"type": "string"
},
"iframeSettings": {
"$ref": "#/definitions/IFrameSettings"
},
"redirectSettings": {
"$ref": "#/definitions/depositRedirectSettings"
}
}
},
"depositDataToSign": {
"description": "The data that will be signed.",
"type": "object",
"properties": {
"rentContractPDF": {
"description": "Base64-encoded string of the document, UTF-8-encoded.",
"type": "string"
}
}
},
"TerminateRequest": {
"required": [
"category",
"username"
],
"type": "object",
"properties": {
"category": {
"description": "Termination category. Use TENANT to release the entire amount to the tenant.\r\nIn case of a SPLIT, provide the amounts to use.\r\nDISPUTE=N/A",
"enum": [
"TENANT",
"SPLIT",
"DISPUTE"
],
"type": "string"
},
"amount": {
"$ref": "#/definitions/ReleaseAmount"
},
"username": {
"description": "The user who initiated the termination",
"maxLength": 100,
"minLength": 2,
"type": "string"
},
"transactionInfo": {
"$ref": "#/definitions/TransactionInfo"
}
}
},
"ReleaseAmount": {
"description": "Release amount for SPLIT category",
"type": "object",
"properties": {
"tenant": {
"format": "double",
"description": "Amount released to the tenant",
"type": "number"
},
"landlord": {
"format": "double",
"description": "Amount released to the landlord",
"type": "number"
}
}
},
"TransactionInfo": {
"description": "Transaction information",
"type": "object",
"properties": {
"landlord": {
"$ref": "#/definitions/ReleaseInfoLandlord"
}
}
},
"ReleaseInfoLandlord": {
"description": "Additional information to add to the bank transfer",
"type": "object",
"properties": {
"kid": {
"description": "KID number for the transfer",
"maxLength": 25,
"minLength": 2,
"type": "string"
},
"description": {
"description": "Description message for the transfer",
"maxLength": 30,
"minLength": 0,
"type": "string"
}
}
},
"CollectionWithPaging[DepositSummary]": {
"type": "object",
"properties": {
"size": {
"format": "int64",
"type": "integer"
},
"links": {
"$ref": "#/definitions/depositLinks"
},
"offset": {
"format": "int32",
"type": "integer"
},
"limit": {
"format": "int32",
"type": "integer"
},
"data": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/DepositSummary"
}
}
}
},
"depositLinks": {
"type": "object",
"properties": {
"next": {
"type": "string"
},
"previous": {
"type": "string"
},
"first": {
"type": "string"
}
}
},
"DepositSummary": {
"description": "A summary containing core information about a deposit",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The deposit's unique identifier.",
"type": "string"
},
"documentId": {
"format": "uuid",
"description": "The document's unique identifier.",
"type": "string"
},
"status": {
"$ref": "#/definitions/depositStatus"
},
"createdDate": {
"format": "date-time",
"description": "Creation date (ISO-8601)",
"type": "string"
},
"paymentDeadline": {
"format": "date-time",
"description": "Deadline for when payment must have been made to the account (ISO-8601).",
"type": "string"
},
"tenants": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/TenantSummary"
}
},
"landlord": {
"$ref": "#/definitions/LandlordSummary"
}
}
},
"TenantSummary": {
"description": "Basic tenant info",
"type": "object",
"properties": {
"firstName": {
"description": "First name of the tenant",
"type": "string"
},
"lastName": {
"description": "Last name of the tenant",
"type": "string"
}
}
},
"LandlordSummary": {
"description": "Basic landlord info",
"type": "object",
"properties": {
"name": {
"description": "Name of the landlord",
"type": "string"
}
}
},
"OauthAPIClientResponse": {
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"Created": {
"format": "date-time",
"type": "string"
},
"LastChanged": {
"format": "date-time",
"type": "string"
},
"ClientSecrets": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthSecret"
}
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"Claims": {
"type": "array",
"items": {
"$ref": "#/definitions/ClaimLite"
}
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientId": "8e5f7815-adcf-4af2-8acd-dccc7b4d2479",
"ClientName": "Stark",
"Enabled": true,
"Created": "2016-11-29T00:00:00",
"LastChanged": "2016-12-22T00:00:00",
"ClientSecrets": [
{
"Description": "",
"Value": "pqr+riE275mFasdaewfrergt45gfdsedE=",
"Type": "SharedSecret"
}
],
"AllowedScopes": [
"account_read",
"account_write"
],
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"Claims": [
{
"Type": "client_providerid",
"Value": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609"
}
],
"AllowedCorsOrigins": [
"https://www.yourapp.com"
]
}
},
"OauthSecret": {
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"Value": {
"type": "string"
},
"Expiration": {
"format": "date-time",
"type": "string"
},
"Type": {
"type": "string"
}
}
},
"ClaimLite": {
"type": "object",
"properties": {
"Type": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"OpenIdClientResponse": {
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"Created": {
"format": "date-time",
"type": "string"
},
"LastChanged": {
"format": "date-time",
"type": "string"
},
"ClientSecrets": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthSecret"
}
},
"ClientUri": {
"type": "string"
},
"RequireConsent": {
"type": "boolean"
},
"AllowRememberConsent": {
"type": "boolean"
},
"Flow": {
"enum": [
"AuthorizationCode",
"Implicit",
"Hybrid",
"ClientCredentials",
"ResourceOwner",
"Custom",
"AuthorizationCodeWithProofKey",
"HybridWithProofKey"
],
"type": "string"
},
"AllowClientCredentialsOnly": {
"type": "boolean"
},
"RedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"PostLogoutRedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"LogoutUri": {
"description": "Specifies logout URI at client for HTTP based logout.",
"type": "string"
},
"RequireSignOutPrompt": {
"description": "Specifies if the client will always show a confirmation page for sign-out. Defaults to false.",
"type": "boolean"
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"IdentityProviderRestrictions": {
"description": "List of Identityproviders allowed. This requires setup on your account.",
"type": "array",
"items": {
"enum": [
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"MOBILECONNECT",
"SMS_OTP",
"Facebook",
"Google",
"LinkedIn",
"GitHub",
"Microsoft"
],
"type": "string"
}
},
"IdentityTokenLifetime": {
"format": "int32",
"description": "Lifetime of identity token in seconds (defaults to 300 seconds / 5 minutes)",
"type": "integer"
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"IncludeJwtId": {
"description": "Gets or sets a value indicating whether JWT access tokens should include an identifier",
"type": "boolean"
},
"Claims": {
"type": "array",
"items": {
"$ref": "#/definitions/ClaimLite"
}
},
"AlwaysSendClientClaims": {
"description": "Gets or sets a value indicating whether client claims should be always included in the access tokens - or only for client credentials flow.",
"type": "boolean"
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
},
"AllowAccessTokensViaBrowser": {
"type": "boolean"
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientId": "8e5f7815-adcf-4af2-8acd-dccc7b4d2479",
"ClientName": "Stark",
"Enabled": true,
"Created": "2016-11-29T00:00:00",
"LastChanged": "2016-12-22T00:00:00",
"ClientUri": "https://exampleuri.com",
"RequireConsent": true,
"AllowRememberConsent": true,
"Flow": "ClientCredentials",
"AllowClientCredentialsOnly": true,
"RedirectUris": [
"https://exampleuri.com"
],
"PostLogoutRedirectUris": [
"https://exampleuri.com",
"https://exampleuri2.com"
],
"LogoutUri": "https://exampleuri.com",
"RequireSignOutPrompt": false,
"AllowedScopes": [
"mobileconnect",
"openid"
],
"IdentityProviderRestrictions": [
"GitHub",
"NO_BANKID_WEB",
"NO_BANKID_MOBILE"
],
"IdentityTokenLifetime": 5441,
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"IncludeJwtId": true,
"Claims": [
{
"Type": "client_providerid",
"Value": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609"
}
],
"AlwaysSendClientClaims": true,
"AllowedCorsOrigins": [
"https://www.yourapp.com"
],
"AllowAccessTokensViaBrowser": true
}
},
"PdfTemplate": {
"required": [
"Id",
"Name"
],
"type": "object",
"properties": {
"CoverPageSetting": {
"description": "Coverpage is the page added to the document at the beginning or end that show a list of the signers. This settings hides that page or put it first or last. Default firstpage",
"enum": [
"FIRSTPAGE",
"LASTPAGE",
"HIDDEN"
],
"type": "string"
},
"AddListOfSignaturesOnLastPageOfExistingPDF": {
"description": "Coverpage is the page added to the document at the beginning or end that show a list of the signers. This settings hides that page or put it first or last. Default firstpage",
"type": "boolean"
},
"CoverPageHtml": {
"description": "The html template for the coverpage, if this is set it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "string"
},
"DetailsPageHtml": {
"description": "List of html templates for the details attatchments. If this is set for one or more language, it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"VerifiedTemplate": {
"description": "List of labels for the verified label on the footer on each page. If this is set it will override the default text. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"Labels": {
"description": "List of labels for the templates, this are used in the html templates. If this is set it will override the default labels. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"no": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"sv": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"da": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fi": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"IncludeLogo": {
"description": "Include your logo in the Pdf template",
"type": "boolean"
},
"TimeZone": {
"description": "The time zone that is used for displaying signing time in the PADES (See: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values for valid values) Defaults to W. Europe Standard Time",
"type": "string"
},
"LogoSourceUrl": {
"description": "Url to the logo that you want to use in your template",
"type": "string"
},
"Id": {
"format": "uuid",
"type": "string"
},
"Name": {
"description": "The name of the Pdf template",
"type": "string"
},
"LastEdited": {
"format": "date-time",
"description": "Timestamp when the template is last edited",
"type": "string"
}
},
"example": {
"CoverPageSetting": "FIRSTPAGE",
"AddListOfSignaturesOnLastPageOfExistingPDF": false,
"CoverPageHtml": "Html code for the coverpage base64 encoded",
"DetailsPageHtml": {
"da": "Html code for the detailspage in Danish base64 encoded",
"en": "Html code for the detailspage in English base64 encoded",
"no": "Html code for the detailspage in Norwegian base64 encoded",
"sv": "Html code for the detailspage in Swedish base64 encoded",
"fi": "Html code for the detailspage in Finish base64 encoded"
},
"VerifiedTemplate": {
"da": "Verified template in Danish",
"en": "Verified template in English",
"no": "Verfied template in Norwegian",
"sv": "Verfied template inSwedish",
"fi": "Verfied template in Finish"
},
"Labels": {
"da": {
"label_key": "Label text to override or add"
}
},
"IncludeLogo": false,
"Id": "6d9ebd0d-f2bf-4c93-ab52-1f094109fd0f",
"Name": "My default template",
"LastEdited": "2020-02-03T14:38:13.1911933+00:00"
}
},
"UpdatePdfTemplate": {
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the Pdf template",
"type": "string"
},
"CoverPageSetting": {
"description": "Coverpage is the page added to the document at the beginning or end that show a list of the signers. This settings hides that page or put it first or last. Default firstpage",
"enum": [
"FIRSTPAGE",
"LASTPAGE",
"HIDDEN"
],
"type": "string"
},
"AddListOfSignaturesOnLastPageOfExistingPDF": {
"description": "Adds a list of signer names on the last page of the PDF, only use this if you are sure that you have room for the signatures. Contact support for more information.",
"type": "boolean"
},
"CoverPageHtml": {
"description": "The html template for the coverpage, if this is set it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "string"
},
"DetailsPageHtml": {
"description": "List of html templates for the details attatchments. If this is set for one or more language, it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"VerifiedTemplate": {
"description": "List of labels for the verified label on the footer on each page. If this is set it will override the default text. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"Labels": {
"description": "List of labels for the templates, this are used in the html templates. If this is set it will override the default labels. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"no": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"sv": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"da": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fi": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"IncludeLogo": {
"description": "Include your logo in the Pdf template",
"type": "boolean"
},
"TimeZone": {
"description": "The time zone that is used for displaying signing time in the PADES (See: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values for valid values) Defaults to W. Europe Standard Time",
"type": "string"
},
"LogoSourceUrl": {
"description": "Url to the logo that you want to use in your template",
"type": "string"
}
}
},
"Account": {
"required": [
"Name",
"MvaNumber",
"CompanyPhone",
"CompanyEmail"
],
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Account Id",
"type": "string"
},
"CustomerNumber": {
"description": "Uni micro customer number",
"type": "string"
},
"Resources": {
"$ref": "#/definitions/Resources"
},
"SlaTag": {
"description": "Sla agreement",
"type": "string"
},
"TestAccount": {
"description": "Test account",
"type": "boolean"
},
"Enabled": {
"description": "Account enabled",
"type": "boolean"
},
"Name": {
"description": "Name of the account owner (company)",
"type": "string"
},
"MvaNumber": {
"description": "Mva / Organization number",
"type": "string"
},
"CompanyPhone": {
"type": "string"
},
"CompanyEmail": {
"type": "string"
},
"CompanyUrl": {
"type": "string"
},
"Contact": {
"$ref": "#/definitions/Contact"
},
"adminAddress": {
"$ref": "#/definitions/adminAddress"
},
"Dealer": {
"$ref": "#/definitions/DealerInfo"
},
"Settings": {
"$ref": "#/definitions/Settings"
},
"Country": {
"type": "string"
}
},
"example": {
"Id": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"CustomerNumber": "100000",
"Resources": {
"LogoUrl": "",
"CssUrl": ""
},
"TestAccount": false,
"Enabled": false,
"Name": "Stark Industries",
"MvaNumber": "123456789",
"CompanyPhone": "+47111111111",
"CompanyEmail": "ironman@starkindustries.com",
"CompanyUrl": "https://tony.starkindustries.com",
"Contact": {
"Name": "Tony Stark",
"Phone": "",
"Mobile": "+4712345678",
"Email": "tony@starkindustries.com"
},
"adminAddress": {
"Address1": "10-8-80 Malibu Point",
"PostalCode": "90265",
"City": "California",
"Country": "US"
},
"Dealer": {
"Id": "312101e2-d247-4a35-a174-a03be79433b6",
"Reference": "344455676"
},
"Settings": {
"SMSSender": "Stark Industries"
}
}
},
"Resources": {
"description": "Logo / Styling",
"type": "object",
"properties": {
"LogoUrl": {
"description": "The logo uploaded to this account",
"type": "string"
},
"CssUrl": {
"description": "Custom css uploaded to this account",
"type": "string"
}
}
},
"Contact": {
"description": "Company contact person",
"required": [
"Name",
"Mobile",
"Email"
],
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Phone": {
"type": "string"
},
"Mobile": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"adminAddress": {
"description": "Company address",
"type": "object",
"properties": {
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"City": {
"type": "string"
},
"Country": {
"type": "string"
}
}
},
"DealerInfo": {
"description": "Dealer information",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string"
},
"Reference": {
"type": "string"
}
}
},
"Settings": {
"description": "Other account settings",
"type": "object",
"properties": {
"SMSSender": {
"type": "string"
}
}
},
"CreateAccountRequest": {
"required": [
"Name",
"MvaNumber",
"CompanyPhone",
"CompanyEmail"
],
"type": "object",
"properties": {
"Name": {
"description": "Name of the account owner (company)",
"type": "string"
},
"MvaNumber": {
"description": "Mva / Organization number",
"type": "string"
},
"CompanyPhone": {
"type": "string"
},
"CompanyEmail": {
"type": "string"
},
"CompanyUrl": {
"type": "string"
},
"Contact": {
"$ref": "#/definitions/Contact"
},
"adminAddress": {
"$ref": "#/definitions/adminAddress"
},
"Dealer": {
"$ref": "#/definitions/DealerInfo"
},
"Settings": {
"$ref": "#/definitions/Settings"
},
"Country": {
"type": "string"
}
},
"example": {
"Name": "Stark Industries",
"MvaNumber": "123456789",
"CompanyPhone": "+47111111111",
"CompanyEmail": "ironman@starkindustries.com",
"CompanyUrl": "https://tony.starkindustries.com",
"Contact": {
"Name": "Tony Stark",
"Phone": "",
"Mobile": "+4712345678",
"Email": "tony@starkindustries.com"
},
"adminAddress": {
"Address1": "10-8-80 Malibu Point",
"PostalCode": "90265",
"City": "California",
"Country": "US"
},
"Dealer": {
"Id": "312101e2-d247-4a35-a174-a03be79433b6",
"Reference": "344455676"
},
"Settings": {
"SMSSender": "Stark Industries"
}
}
},
"UpdateAccountRequest": {
"required": [
"Id",
"Name",
"MvaNumber",
"CompanyPhone",
"CompanyEmail"
],
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Account Id",
"type": "string"
},
"Name": {
"description": "Name of the account owner (company)",
"type": "string"
},
"MvaNumber": {
"description": "Mva / Organization number",
"type": "string"
},
"CompanyPhone": {
"type": "string"
},
"CompanyEmail": {
"type": "string"
},
"CompanyUrl": {
"type": "string"
},
"Contact": {
"$ref": "#/definitions/Contact"
},
"adminAddress": {
"$ref": "#/definitions/adminAddress"
},
"Dealer": {
"$ref": "#/definitions/DealerInfo"
},
"Settings": {
"$ref": "#/definitions/Settings"
},
"Country": {
"type": "string"
}
},
"example": {
"Id": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"Name": "Stark Industries",
"MvaNumber": "123456789",
"CompanyPhone": "+47111111111",
"CompanyEmail": "ironman@starkindustries.com",
"CompanyUrl": "https://tony.starkindustries.com",
"Contact": {
"Name": "Tony Stark",
"Phone": "",
"Mobile": "+4712345678",
"Email": "tony@starkindustries.com"
},
"adminAddress": {
"Address1": "10-8-80 Malibu Point",
"PostalCode": "90265",
"City": "California",
"Country": "US"
},
"Dealer": {
"Id": "312101e2-d247-4a35-a174-a03be79433b6",
"Reference": "344455676"
},
"Settings": {
"SMSSender": "Stark Industries"
}
}
},
"AccountListItem": {
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"Name": {
"type": "string"
},
"OrgNo": {
"type": "string"
},
"UniCustomerNo": {
"type": "string"
},
"Created": {
"format": "date-time",
"type": "string"
},
"LastModified": {
"format": "date-time",
"type": "string"
},
"DealerId": {
"type": "string"
},
"DealerName": {
"type": "string"
},
"DealerReference": {
"type": "string"
},
"Enabled": {
"type": "boolean"
}
}
},
"AccountNameItem": {
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"Name": {
"type": "string"
},
"Enabled": {
"type": "boolean"
}
}
},
"Dealer": {
"required": [
"Id",
"Name",
"CustomerNumber"
],
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string"
},
"Name": {
"type": "string"
},
"CustomerNumber": {
"format": "int32",
"type": "integer"
},
"MvaNumber": {
"type": "string"
},
"CompanyPhone": {
"type": "string"
},
"CompanyEmail": {
"type": "string"
},
"CompanyUrl": {
"type": "string"
},
"Onboarding": {
"$ref": "#/definitions/Onboarding"
}
},
"example": {
"Id": "0910d29f-9dd3-44fb-8e74-f16c13f3ba9c",
"Name": "Marvel",
"CustomerNumber": 10000001,
"MvaNumber": "987654321",
"CompanyPhone": "+4798765432",
"CompanyEmail": "support@marvel.com",
"CompanyUrl": "https://marvel.com",
"Onboarding": {
"Heading": "Marvel",
"LeadParagraph": "Marvel delievers quality comics",
"LogoUrl": "",
"ReturnUrl": "https://marvel.com/boarded"
}
}
},
"Onboarding": {
"type": "object",
"properties": {
"Heading": {
"type": "string"
},
"LeadParagraph": {
"type": "string"
},
"LogoUrl": {
"type": "string"
},
"ReturnUrl": {
"type": "string"
}
}
},
"Transaction": {
"type": "object",
"properties": {
"ID": {
"description": "Transaction ID",
"type": "string"
},
"Date": {
"format": "date-time",
"description": "The date for the transaction",
"type": "string"
},
"ProductID": {
"description": "Product ID (SIGN, IDENTIFICATION etc)",
"type": "string"
},
"Description": {
"description": "Transaction description",
"type": "string"
},
"Count": {
"format": "int32",
"description": "Number of transactions for the selected date",
"type": "integer"
},
"CustomerNumber": {
"format": "int32",
"description": "Your customer number in our invocing system",
"type": "integer"
},
"ExternalReference": {
"description": "Your reference to the transaction (by ExternalRef in the API call)",
"type": "string"
},
"DepartmentId": {
"description": "The Departments ID if specified",
"type": "string"
}
},
"example": {
"ID": "5cde09af-23bb-445f-a291-dd27152e1207",
"Date": "2016-11-29T00:00:00",
"ProductID": "NO-BANKID-AUTH",
"Description": "Login for: Stark, Tony with: NO_BANKID_WEB External ref: 765a7ed2d95c4000b14d7a48eb267546",
"Count": 1,
"CustomerNumber": 10000,
"ExternalReference": "765a7ed2d95c4000b14d7a48eb267546",
"DepartmentId": "AssignmentNumber:11572"
}
},
"OauthClientListItemResponse": {
"type": "object",
"properties": {
"ClientId": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"ClientName": {
"type": "string"
},
"AccountId": {
"format": "uuid",
"type": "string"
},
"Created": {
"format": "date-time",
"type": "string"
},
"LastChanged": {
"format": "date-time",
"type": "string"
}
}
},
"PdfTemplateListItem": {
"required": [
"Id",
"Name"
],
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string"
},
"Name": {
"description": "The name of the Pdf template",
"type": "string"
},
"LastEdited": {
"format": "date-time",
"description": "Timestamp when the template is last edited",
"type": "string"
}
},
"example": {
"Id": "d7a77231-a5a6-4904-80a8-8cfe4f0177a1",
"Name": "My default template",
"LastEdited": "2020-02-03T14:38:13.4035415+00:00"
}
},
"CreatePdfTemplate": {
"description": "Create a new Pdf template",
"required": [
"Name"
],
"type": "object",
"properties": {
"Name": {
"description": "The name of the Pdf template",
"type": "string"
},
"CoverPageSetting": {
"description": "Coverpage is the page added to the document at the beginning or end that show a list of the signers. This settings hides that page or put it first or last. Default firstpage",
"enum": [
"FIRSTPAGE",
"LASTPAGE",
"HIDDEN"
],
"type": "string"
},
"AddListOfSignaturesOnLastPageOfExistingPDF": {
"description": "Adds a list of signer names on the last page of the PDF, only use this if you are sure that you have room for the signatures. Contact support for more information.",
"type": "boolean"
},
"CoverPageHtml": {
"description": "The html template for the coverpage, if this is set it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "string"
},
"DetailsPageHtml": {
"description": "List of html templates for the details attatchments. If this is set for one or more language, it will override the default template. See our documentation on more info on how to make your own custom template.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"VerifiedTemplate": {
"description": "List of labels for the verified label on the footer on each page. If this is set it will override the default text. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "string"
},
"no": {
"type": "string"
},
"sv": {
"type": "string"
},
"da": {
"type": "string"
},
"fi": {
"type": "string"
}
}
},
"Labels": {
"description": "List of labels for the templates, this are used in the html templates. If this is set it will override the default labels. See our documentation on more info on how to customize.",
"type": "object",
"properties": {
"en": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"no": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"sv": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"da": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fi": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"IncludeLogo": {
"description": "Include your logo in the Pdf template",
"type": "boolean"
},
"TimeZone": {
"description": "The time zone that is used for displaying signing time in the PADES (See: https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values for valid values) Defaults to W. Europe Standard Time",
"type": "string"
},
"LogoSourceUrl": {
"description": "Url to the logo that you want to use in your template",
"type": "string"
}
},
"example": {
"Name": "My default template",
"CoverPageSetting": "FIRSTPAGE",
"AddListOfSignaturesOnLastPageOfExistingPDF": false,
"CoverPageHtml": "Html code for the coverpage base64 encoded",
"DetailsPageHtml": {
"da": "Html code for the detailspage in Danish base64 encoded",
"en": "Html code for the detailspage in English base64 encoded",
"no": "Html code for the detailspage in Norwegian base64 encoded",
"sv": "Html code for the detailspage in Swedish base64 encoded",
"fi": "Html code for the detailspage in Finish base64 encoded"
},
"VerifiedTemplate": {
"da": "Verified template in Danish",
"en": "Verified template in English",
"no": "Verfied template in Norwegian",
"sv": "Verfied template inSwedish",
"fi": "Verfied template in Finish"
},
"Labels": {
"da": {
"label_key": "Label text to override or add"
}
},
"IncludeLogo": false
}
},
"AccountLogo": {
"required": [
"AccountId",
"Base64EncodedLogo",
"FileName"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"Base64EncodedLogo": {
"type": "string"
},
"FileName": {
"type": "string"
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"Base64EncodedLogo": "This string has to contain a base64 encoded image",
"FileName": "logo.png"
}
},
"adminStyling": {
"required": [
"AccountId",
"Base64EncodedCssData",
"FileName"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"Base64EncodedCssData": {
"type": "string"
},
"FileName": {
"type": "string"
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"Base64EncodedCssData": "This string has to contain base64 encoded css data",
"FileName": "starkindustries.css"
}
},
"DealerLogo": {
"required": [
"DealerId",
"Base64EncodedLogo",
"FileName"
],
"type": "object",
"properties": {
"DealerId": {
"format": "uuid",
"type": "string"
},
"Base64EncodedLogo": {
"type": "string"
},
"FileName": {
"type": "string"
}
},
"example": {
"DealerId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"Base64EncodedLogo": "This string has to contain a base64 encoded image",
"FileName": "logo.png"
}
},
"CreateOauthAPIClientRequest": {
"required": [
"AccountId",
"ClientName"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientName": {
"type": "string"
},
"ClientSecrets": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthSecret"
}
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientName": "Stark",
"ClientSecrets": [
{
"Description": "",
"Value": "pqr+riE275mFasdaewfrergt45gfdsedE=",
"Type": "SharedSecret"
}
],
"AllowedScopes": [
"account_read",
"account_write"
],
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"AllowedCorsOrigins": [
"https://www.yourapp.com"
]
}
},
"UpdateOauthAPIClientRequest": {
"required": [
"AccountId",
"ClientId",
"ClientName"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"ClientSecrets": {
"type": "array",
"items": {
"$ref": "#/definitions/OauthSecret"
}
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientId": "8e5f7815-adcf-4af2-8acd-dccc7b4d2479",
"ClientName": "Stark",
"Enabled": true,
"ClientSecrets": [
{
"Description": "",
"Value": "pqr+riE275mFasdaewfrergt45gfdsedE=",
"Type": "SharedSecret"
}
],
"AllowedScopes": [
"account_read",
"account_write"
],
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"AllowedCorsOrigins": [
"https://www.yourapp.com"
]
}
},
"CreateOpenIdClientRequest": {
"required": [
"AccountId",
"ClientName"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientName": {
"type": "string"
},
"ClientUri": {
"type": "string"
},
"RequireConsent": {
"type": "boolean"
},
"AllowRememberConsent": {
"type": "boolean"
},
"Flow": {
"enum": [
"AuthorizationCode",
"Implicit",
"Hybrid",
"ClientCredentials",
"ResourceOwner",
"Custom",
"AuthorizationCodeWithProofKey",
"HybridWithProofKey"
],
"type": "string"
},
"AllowClientCredentialsOnly": {
"type": "boolean"
},
"RedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"PostLogoutRedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"LogoutUri": {
"description": "Specifies logout URI at client for HTTP based logout.",
"type": "string"
},
"RequireSignOutPrompt": {
"description": "Specifies if the client will always show a confirmation page for sign-out. Defaults to false.",
"type": "boolean"
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"IdentityProviderRestrictions": {
"description": "Setup which id providers that should be allowed to use",
"type": "array",
"items": {
"enum": [
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"MOBILECONNECT",
"SMS_OTP",
"Facebook",
"Google",
"LinkedIn",
"GitHub",
"Microsoft"
],
"type": "string"
}
},
"IdentityTokenLifetime": {
"format": "int32",
"description": "Lifetime of identity token in seconds (defaults to 300 seconds / 5 minutes)",
"type": "integer"
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"IncludeJwtId": {
"description": "Gets or sets a value indicating whether JWT access tokens should include an identifier",
"type": "boolean"
},
"AlwaysSendClientClaims": {
"description": "Gets or sets a value indicating whether client claims should be always included in the access tokens - or only for client credentials flow.",
"type": "boolean"
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
},
"AllowAccessTokensViaBrowser": {
"type": "boolean"
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientName": "Stark",
"ClientUri": "https://exampleuri.com",
"RequireConsent": true,
"AllowRememberConsent": true,
"Flow": "ClientCredentials",
"AllowClientCredentialsOnly": true,
"RedirectUris": [
"https://exampleuri.com"
],
"PostLogoutRedirectUris": [
"https://exampleuri.com",
"https://exampleuri2.com"
],
"LogoutUri": "https://exampleuri.com",
"RequireSignOutPrompt": false,
"AllowedScopes": [
"mobileconnect",
"openid"
],
"IdentityTokenLifetime": 5441,
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"IncludeJwtId": true,
"AlwaysSendClientClaims": true,
"AllowedCorsOrigins": [
"https://www.yourapp.com"
],
"AllowAccessTokensViaBrowser": true
}
},
"UpdateOpenIdClientRequest": {
"required": [
"AccountId",
"ClientId",
"ClientName",
"RedirectUris"
],
"type": "object",
"properties": {
"AccountId": {
"format": "uuid",
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"Enabled": {
"type": "boolean"
},
"ClientUri": {
"type": "string"
},
"RequireConsent": {
"type": "boolean"
},
"AllowRememberConsent": {
"type": "boolean"
},
"Flow": {
"enum": [
"AuthorizationCode",
"Implicit",
"Hybrid",
"ClientCredentials",
"ResourceOwner",
"Custom",
"AuthorizationCodeWithProofKey",
"HybridWithProofKey"
],
"type": "string"
},
"AllowClientCredentialsOnly": {
"type": "boolean"
},
"RedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"PostLogoutRedirectUris": {
"type": "array",
"items": {
"type": "string"
}
},
"LogoutUri": {
"description": "Specifies logout URI at client for HTTP based logout.",
"type": "string"
},
"RequireSignOutPrompt": {
"description": "Specifies if the client will always show a confirmation page for sign-out. Defaults to false.",
"type": "boolean"
},
"AllowedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"IdentityProviderRestrictions": {
"description": "Setup which id providers that should be allowed to use",
"type": "array",
"items": {
"enum": [
"NO_BANKID_MOBILE",
"NO_BANKID_WEB",
"SWE_BANKID",
"NO_BUYPASS",
"DA_NEMID",
"FI_TUPAS",
"MOBILECONNECT",
"SMS_OTP",
"Facebook",
"Google",
"LinkedIn",
"GitHub",
"Microsoft"
],
"type": "string"
}
},
"IdentityTokenLifetime": {
"format": "int32",
"description": "Lifetime of identity token in seconds (defaults to 300 seconds / 5 minutes)",
"type": "integer"
},
"AccessTokenLifetime": {
"format": "int32",
"description": "Lifetime of access token in seconds (defaults to 3600 seconds / 1 hour)",
"type": "integer"
},
"AbsoluteRefreshTokenLifetime": {
"format": "int32",
"description": "Maximum lifetime of a refresh token in seconds. Defaults to 2592000 seconds / 30 days",
"type": "integer"
},
"SlidingRefreshTokenLifetime": {
"format": "int32",
"description": "Sliding lifetime of a refresh token in seconds. Defaults to 1296000 seconds / 15 days",
"type": "integer"
},
"RefreshTokenUsage": {
"enum": [
"ReUse",
"OneTimeOnly"
],
"type": "string"
},
"UpdateAccessTokenClaimsOnRefresh": {
"description": "Gets or sets a value indicating whether the access token (and its claims) should be updated on a refresh token request.",
"type": "boolean"
},
"RefreshTokenExpiration": {
"enum": [
"Sliding",
"Absolute"
],
"type": "string"
},
"AccessTokenType": {
"enum": [
"Jwt",
"Reference"
],
"type": "string"
},
"IncludeJwtId": {
"description": "Gets or sets a value indicating whether JWT access tokens should include an identifier",
"type": "boolean"
},
"AlwaysSendClientClaims": {
"description": "Gets or sets a value indicating whether client claims should be always included in the access tokens - or only for client credentials flow.",
"type": "boolean"
},
"AllowedCorsOrigins": {
"type": "array",
"items": {
"type": "string"
}
},
"AllowAccessTokensViaBrowser": {
"type": "boolean"
}
},
"example": {
"AccountId": "6f6c7b6e-1ef3-4d61-865c-90c8a06eb609",
"ClientId": "8e5f7815-adcf-4af2-8acd-dccc7b4d2479",
"ClientName": "Stark",
"Enabled": true,
"ClientUri": "https://exampleuri.com",
"RequireConsent": true,
"AllowRememberConsent": true,
"Flow": "ClientCredentials",
"AllowClientCredentialsOnly": true,
"RedirectUris": [
"https://exampleuri.com"
],
"PostLogoutRedirectUris": [
"https://exampleuri.com",
"https://exampleuri2.com"
],
"LogoutUri": "https://exampleuri.com",
"RequireSignOutPrompt": false,
"AllowedScopes": [
"mobileconnect",
"openid"
],
"IdentityTokenLifetime": 5441,
"AccessTokenLifetime": 3600,
"AbsoluteRefreshTokenLifetime": 2592000,
"SlidingRefreshTokenLifetime": 1296000,
"RefreshTokenUsage": "OneTimeOnly",
"UpdateAccessTokenClaimsOnRefresh": true,
"RefreshTokenExpiration": "Absolute",
"AccessTokenType": "Jwt",
"IncludeJwtId": true,
"AlwaysSendClientClaims": true,
"AllowedCorsOrigins": [
"https://www.yourapp.com"
],
"AllowAccessTokensViaBrowser": true
}
},
"TemplateWithIdPreview": {
"required": [
"PrimaryLanguage"
],
"type": "object",
"properties": {
"PrimaryLanguage": {
"description": "Primary language to use in the preview (required)",
"enum": [
"en",
"no",
"sv",
"da",
"fi"
],
"type": "string"
},
"SecondaryLanguage": {
"description": "Secondary language to use in the prewview (optional)",
"enum": [
"en",
"no",
"sv",
"da",
"fi"
],
"type": "string"
},
"XmlSignature": {
"description": "Xml package signature in base64 encoding",
"type": "string"
}
}
},
"Stream": {
"type": "object",
"properties": {
"CanRead": {
"type": "boolean",
"readOnly": true
},
"CanSeek": {
"type": "boolean",
"readOnly": true
},
"CanTimeout": {
"type": "boolean",
"readOnly": true
},
"CanWrite": {
"type": "boolean",
"readOnly": true
},
"Length": {
"format": "int64",
"type": "integer",
"readOnly": true
},
"Position": {
"format": "int64",
"type": "integer"
},
"ReadTimeout": {
"format": "int32",
"type": "integer"
},
"WriteTimeout": {
"format": "int32",
"type": "integer"
}
}
},
"TemplatePreview": {
"required": [
"PdfTemplate",
"PrimaryLanguage"
],
"type": "object",
"properties": {
"PdfTemplate": {
"$ref": "#/definitions/PdfTemplate",
"description": "The PDF template to preview"
},
"PrimaryLanguage": {
"description": "Primary language to use in the preview (required)",
"enum": [
"en",
"no",
"sv",
"da",
"fi"
],
"type": "string"
},
"SecondaryLanguage": {
"description": "Secondary language to use in the prewview (optional)",
"enum": [
"en",
"no",
"sv",
"da",
"fi"
],
"type": "string"
},
"XmlSignature": {
"description": "Xml package signature in base64 encoding",
"type": "string"
}
}
},
"OauthClientId": {
"required": [
"ClientId",
"AccountId"
],
"type": "object",
"properties": {
"ClientId": {
"type": "string"
},
"AccountId": {
"format": "uuid",
"type": "string"
}
}
},
"ValidateJwtDto": {
"required": [
"jwt"
],
"type": "object",
"properties": {
"jwt": {
"description": "The JWT to validate.",
"type": "string"
}
}
},
"JwtValidationResultDto": {
"type": "object",
"properties": {
"valid": {
"description": "Whether the JWT is valid.",
"type": "boolean"
},
"expires": {
"format": "date-time",
"description": "The expiration time on or after which the JWT will not be accepted for processing.",
"type": "string"
},
"payload": {
"description": "The JWT payload.",
"type": "object"
},
"error": {
"description": "Error message explaining reason for a failed validation.",
"type": "string"
}
}
},
"LanguageSetDTO": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"isActive": {
"type": "boolean"
}
}
},
"LanguageSetUpdateDTO": {
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"isActive": {
"type": "boolean"
}
}
},
"LanguageDTO": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"LanguageSetCreateDTO": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"isActive": {
"type": "boolean"
}
}
},
"TranslationDTO": {
"type": "object",
"properties": {
"subjectId": {
"format": "int32",
"type": "integer"
},
"key": {
"type": "string"
},
"language": {
"type": "string"
},
"value": {
"type": "string"
},
"defaultValue": {
"type": "string"
}
}
},
"TranslationUpdateDTO": {
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"maxLength": 2500,
"minLength": 1,
"type": "string"
}
}
},
"ValidateSDORequest": {
"required": [
"sdoData",
"externalReference"
],
"type": "object",
"properties": {
"sdoData": {
"description": "Base 64 encoded SDO (Signed document)",
"type": "string"
},
"externalReference": {
"description": "The service reference for the signing. Will be used for auditlog, and invoicing",
"type": "string"
},
"dataToValidate": {
"description": "Check that the original data matches the sdo data (optional, base64 encoded)",
"type": "string"
},
"signersToValidate": {
"description": "Add signers to validate (optional)",
"type": "array",
"items": {
"$ref": "#/definitions/Signers"
}
}
},
"example": {
"sdoData": "Base 64 encoded sdo data (required)",
"externalReference": "Your reference",
"dataToValidate": "base 64 encoded data to validate (optional)",
"signersToValidate": [
{
"identificator": "12345678911",
"identificatorType": "SSN"
}
]
}
},
"Signers": {
"type": "object",
"properties": {
"identificator": {
"type": "string"
},
"identificatorType": {
"enum": [
"Unknown",
"BankIDUniqueId",
"SSN",
"OrganizationNumber"
],
"type": "string"
}
}
},
"ValidateSDOResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"valid": {
"description": "Is the SDO valid",
"type": "boolean"
},
"seal": {
"$ref": "#/definitions/Seal",
"description": "Is the Seal of the SDO valid"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/definitions/ValidatedSigners"
}
},
"summary": {
"type": "string"
},
"validationError": {
"$ref": "#/definitions/ValidationError"
},
"auditId": {
"format": "uuid",
"description": "The AuditId vil only be set for users with an account on the API.",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"Seal": {
"type": "object",
"properties": {
"sealedBy": {
"type": "string"
},
"sealedTimestamp": {
"format": "date-time",
"type": "string"
},
"certificate": {
"$ref": "#/definitions/Certificate"
},
"sealValid": {
"type": "boolean"
}
}
},
"ValidatedSigners": {
"type": "object",
"properties": {
"identificator": {
"type": "string"
},
"identificatorType": {
"enum": [
"Unknown",
"BankIDUniqueId",
"SSN",
"OrganizationNumber"
],
"type": "string"
},
"valid": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
},
"ValidationError": {
"type": "object",
"properties": {
"errorCode": {
"description": "Null if no errors is registered",
"type": "string"
},
"errorMessage": {
"description": "Null if no errors is registered",
"type": "string"
}
}
},
"Certificate": {
"type": "object",
"properties": {
"issuerName": {
"type": "string"
},
"subjectName": {
"type": "string"
},
"validFromDate": {
"format": "date-time",
"type": "string"
},
"validToDate": {
"format": "date-time",
"type": "string"
},
"versionNumber": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"keyAlgorithm": {
"type": "string"
},
"keySize": {
"type": "string"
},
"uniqueId": {
"type": "string"
},
"originator": {
"type": "string"
},
"bankName": {
"type": "string"
},
"dateOfBirth": {
"format": "date-time",
"type": "string"
},
"policyOid": {
"type": "string"
},
"commonName": {
"type": "string"
},
"signingCertficate": {
"type": "string"
},
"x509Certificate": {
"$ref": "#/definitions/X509Certificate"
},
"keyUsage": {
"type": "string"
},
"emailAddress": {
"type": "object"
},
"signingTime": {
"format": "date-time",
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"certificateType": {
"enum": [
"HSM_MERCHANT_CERTIFICATE",
"MOBILE_PERSONAL_CERTIFICATE",
"NETCENTRIC_EMPLOYEE_CERTIFICATE",
"NETCENTRIC_PERSONAL_CERTIFICATE",
"NETCENTRIC_QUALIFIED_EMPLOYEE_CERTIFICATE",
"NETCENTRIC_QUALIFIED_PERSONAL_CERTIFICATE",
"SOFT_MERCHANT_CERTIFICATE",
"UNKNOWN"
],
"type": "string"
}
}
},
"X509Certificate": {
"type": "object",
"properties": {
"rawData": {
"type": "string"
}
}
},
"ParseSDORequest": {
"required": [
"sdoData",
"externalReference"
],
"type": "object",
"properties": {
"sdoData": {
"description": "Base 64 encoded SDO (Signed document)",
"type": "string"
},
"externalReference": {
"description": "The service reference for the signing. Will be used for auditlog, and invoicing",
"type": "string"
},
"fetchSSN": {
"description": "Fetch social security number (Requires valid scope)",
"type": "boolean"
}
},
"example": {
"sdoData": "Base 64 encoded sdo data (required)",
"externalReference": "Your reference",
"fetchSSN": true
}
},
"ParseSDOResponse": {
"type": "object",
"properties": {
"requestId": {
"type": "string"
},
"auditId": {
"format": "uuid",
"description": "Reference to audit log",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"signersValid": {
"description": "Is the signatures valid",
"type": "boolean"
},
"seal": {
"$ref": "#/definitions/Seal",
"description": "Is the sealing of the SDO valid"
},
"signers": {
"description": "Signers list",
"type": "array",
"items": {
"$ref": "#/definitions/SDOSigners"
}
},
"summary": {
"description": "Summary",
"type": "string"
},
"validationError": {
"$ref": "#/definitions/ValidationError",
"description": "Error messages"
},
"signedData": {
"description": "Original data from document (base64 string)",
"type": "string"
}
}
},
"SDOSigners": {
"type": "object",
"properties": {
"certificate": {
"$ref": "#/definitions/Certificate"
},
"name": {
"type": "string"
},
"dateOfBirth": {
"format": "date-time",
"type": "string"
},
"pid": {
"type": "string"
},
"ssn": {
"type": "string"
},
"signedTimestamp": {
"format": "date-time",
"type": "string"
},
"valid": {
"type": "boolean"
},
"ocsp": {
"type": "string"
},
"environment": {
"type": "string"
}
}
},
"merchantSignRequest": {
"required": [
"dataToSign",
"dataFormat",
"externalReference"
],
"type": "object",
"properties": {
"dataToSign": {
"description": "Base 64 encoded data",
"type": "string"
},
"xslt": {
"description": "Base 64 encoded xslt (optional)",
"type": "string"
},
"dataFormat": {
"description": "Format of data (i.e xml)",
"enum": [
"xml",
"pdf",
"txt"
],
"type": "string"
},
"externalReference": {
"description": "The service reference for the signing. Will be used for auditlog, and invoicing",
"type": "string"
},
"signingFormat": {
"description": "Optional, if not set the default setting for the account will be used",
"enum": [
"use_provider_setting",
"no_bankid_seid_sdo",
"no_bankid_pades",
"no_buypass_seid_sdo",
"da_nemid_xmldsig",
"sv_bankid_native_pkcs7"
],
"type": "string"
}
},
"example": {
"dataToSign": "RGV0dGUgZXIgZW4gdGVrc3Qgc29tIGthbiBzaWduZXJlcw==",
"dataFormat": "txt",
"externalReference": "Some reference",
"signingFormat": "no_bankid_seid_sdo"
}
},
"SignResponse": {
"type": "object",
"properties": {
"signedData": {
"description": "base 64 encoded signed data",
"type": "string"
},
"auditLogReference": {
"format": "uuid",
"description": "Reference Id to audit log",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"signingFormat": {
"description": "Signing format",
"enum": [
"use_provider_setting",
"no_bankid_seid_sdo",
"no_bankid_pades",
"no_buypass_seid_sdo",
"da_nemid_xmldsig",
"sv_bankid_native_pkcs7"
],
"type": "string"
},
"error": {
"$ref": "#/definitions/merchantError",
"description": "Error message"
},
"signCertificateBase64String": {
"description": "Signed with certificate",
"type": "string"
},
"transactionId": {
"format": "uuid",
"description": "Id to look up the transaction at a later time",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"signedDocumentId": {
"format": "uuid",
"description": "Id to retrieve signed file (pades)",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"merchantError": {
"type": "object",
"properties": {
"errorCode": {
"format": "int32",
"type": "integer"
},
"errorDescription": {
"type": "string"
}
}
},
"MerchantSignTransaction": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Transaction Id",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"accountId": {
"format": "uuid",
"description": "Your account Id",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"auditLogReference": {
"format": "uuid",
"description": "Audit log Id",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"externalReference": {
"description": "External Reference",
"type": "string"
},
"oauthClientId": {
"description": "The oauth client used in this transaction",
"type": "string"
},
"ipAddress": {
"description": "Ip address",
"type": "string"
},
"xslt": {
"description": "Xslt sha256 hash",
"type": "string"
},
"dataToSign": {
"description": "Data to sign sha256 hash",
"type": "string"
},
"result": {
"description": "Signed data sha256 hash",
"type": "string"
},
"certificate": {
"description": "Certificate",
"type": "string"
},
"timeStamp": {
"format": "date-time",
"description": "Log save time",
"type": "string"
},
"signedDocumentId": {
"format": "uuid",
"description": "For pades retrieval",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"padesCreated": {
"type": "boolean"
},
"padesRetrieved": {
"type": "boolean"
},
"padesDeleted": {
"type": "boolean"
}
}
},
"IdProvider": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/IdProviderType",
"description": "A unique identifier for the ID provider."
},
"name": {
"description": "The name of the ID provider.",
"type": "string"
},
"description": {
"description": "A short description of the ID provider.",
"type": "string"
},
"logoUrl": {
"description": "The URL to the ID provider's logo.",
"type": "string"
},
"logoUrlNegative": {
"description": "The URL to the ID provider's logo (negative version).",
"type": "string"
}
}
},
"IdProviderType": {
"enum": [
"no_bankid_netcentric",
"no_bankid_mobile",
"se_bankid",
"no_buypass",
"dk_nemid",
"fi_eid",
"sms_otp",
"freja",
"github",
"google",
"linkedin"
],
"type": "string"
},
"LanguageDetails": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/identification-v2Language",
"description": "Language identifier"
},
"name": {
"description": "Language name",
"type": "string"
}
}
},
"identification-v2Language": {
"enum": [
"en",
"no",
"sv",
"da"
],
"type": "string"
},
"IdSession": {
"type": "object",
"properties": {
"id": {
"description": "The session's unique identifier.",
"type": "string"
},
"url": {
"description": "The URL to start the identification process. Only applicable to the `iframe` and `redirect` flows.",
"type": "string"
},
"securityReference": {
"description": "The security reference for the identification process. Only applicable to the `headless` flow.",
"type": "string"
},
"status": {
"$ref": "#/definitions/IdSessionStatus",
"description": "The status of the identification session."
},
"created": {
"format": "date-time",
"description": "Time at which the session was created.",
"type": "string"
},
"expires": {
"format": "date-time",
"description": "Time at which the session will expire.",
"type": "string"
},
"provider": {
"description": "The eID provider used for identification.",
"enum": [
"no_bankid_netcentric",
"no_bankid_mobile",
"se_bankid",
"no_buypass",
"dk_nemid",
"fi_eid",
"sms_otp",
"freja",
"github",
"google",
"linkedin"
],
"type": "string"
},
"identity": {
"$ref": "#/definitions/Identity"
},
"environment": {
"$ref": "#/definitions/Environment"
},
"allowedProviders": {
"description": "A list of eID providers that can be used for identification. If not specified, the user will be able to choose from all eID's associated with your Idfy account.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdProviderType"
}
},
"language": {
"$ref": "#/definitions/identification-v2Language",
"description": "The language to use for the identification process. Defaults to `en` (english)."
},
"flow": {
"description": "The type of flow to use.",
"enum": [
"redirect",
"iframe",
"headless"
],
"type": "string"
},
"include": {
"description": "Request additional information about the user.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Include"
}
},
"redirectSettings": {
"$ref": "#/definitions/identification-v2RedirectSettings"
},
"iframeSettings": {
"$ref": "#/definitions/IframeSettings"
},
"externalReference": {
"description": "Your external reference for the session.",
"type": "string"
},
"ui": {
"$ref": "#/definitions/UiSettings"
},
"prefilledInput": {
"$ref": "#/definitions/PrefilledInput"
},
"resources": {
"description": "Resources created for the session.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/ExtraInfoResource"
}
},
"auditTrail": {
"$ref": "#/definitions/AuditTrail"
},
"error": {
"$ref": "#/definitions/identification-v2Error"
}
}
},
"IdSessionStatus": {
"enum": [
"created",
"user_initiated",
"user_aborted",
"timed_out",
"invalidated",
"failed",
"success"
],
"type": "string"
},
"Identity": {
"description": "Details about the identified user. Only available if session has status `success`.",
"type": "object",
"properties": {
"providerId": {
"description": "The user's unique ID from the eID provider.",
"type": "string"
},
"fullName": {
"description": "Full name.",
"type": "string"
},
"firstName": {
"description": "First name.",
"type": "string"
},
"middleName": {
"description": "Middle name.",
"type": "string"
},
"lastName": {
"description": "Last name.",
"type": "string"
},
"dateOfBirth": {
"format": "date-time",
"description": "Date of birth.",
"type": "string"
},
"nin": {
"description": "National identity number.",
"type": "string"
},
"phoneNumber": {
"description": "Phone number.",
"type": "string"
},
"email": {
"description": "Email address.",
"type": "string"
}
}
},
"Environment": {
"description": "Details about the user's environment.",
"type": "object",
"properties": {
"userAgent": {
"description": "The user agent of the user's browser.",
"type": "string"
},
"ipAddress": {
"description": "The user's IP address.",
"type": "string"
}
}
},
"Include": {
"enum": [
"name",
"phone_number",
"date_of_birth",
"nin",
"email",
"resource.vipps_aml_person"
],
"type": "string"
},
"identification-v2RedirectSettings": {
"description": "Redirect settings when using the `redirect` flow.",
"type": "object",
"properties": {
"successUrl": {
"description": "The URL that the user is redirected to after a successful identification.",
"maxLength": 250,
"type": "string"
},
"abortUrl": {
"description": "The URL that the user is redirected to if the session is aborted by the user.",
"maxLength": 250,
"type": "string"
},
"errorUrl": {
"description": "The URL that the user is redirected to if something goes wrong.",
"maxLength": 250,
"type": "string"
}
}
},
"IframeSettings": {
"description": "Iframe settings when using the `iframe` flow.",
"type": "object",
"properties": {
"parentDomains": {
"description": "Parent domains that will iframe the session.",
"uniqueItems": false,
"type": "array",
"items": {
"type": "string"
}
},
"postMessageTargetOrigin": {
"description": "Target origin for cross domain messaging.",
"type": "string"
}
}
},
"UiSettings": {
"description": "UI settings for the identification process.",
"type": "object",
"properties": {
"hideProviderHeader": {
"description": "Whether to hide the logo and title of the selected eID provider.",
"type": "boolean"
},
"hideFooter": {
"description": "Whether to hide the footer with the language switcher and help button.",
"type": "boolean"
},
"themeMode": {
"description": "Whether to use light or dark theme.",
"enum": [
"light",
"dark"
],
"type": "string"
},
"colorTheme": {
"description": "The color theme to use.",
"enum": [
"default",
"pink"
],
"type": "string"
}
}
},
"PrefilledInput": {
"description": "Prefilled input values.",
"type": "object",
"properties": {
"nin": {
"description": "Prefill the user's national identity number.",
"maxLength": 50,
"type": "string"
},
"phoneNumber": {
"description": "Prefill the user's phone number. Must be prefixed with country code.",
"type": "string"
},
"dateOfBirth": {
"description": "Prefill the user's date of birth (YYYY-MM-DD).",
"type": "string"
},
"username": {
"description": "Prefill the user's username.",
"maxLength": 50,
"type": "string"
}
}
},
"ExtraInfoResource": {
"type": "object",
"properties": {
"id": {
"description": "The resource's unique identifier.",
"type": "string"
},
"type": {
"description": "The type of resource.",
"enum": [
"vipps_aml_person"
],
"type": "string"
},
"contentType": {
"description": "The resource's content type.",
"type": "string"
},
"expires": {
"format": "date-time",
"description": "Time at which the resource expires.",
"type": "string"
},
"status": {
"description": "The status of the resource.",
"enum": [
"pending",
"missing_credentials",
"unsupported_idp",
"not_found",
"unknown_error",
"success",
"insufficient_access",
"invalid_credentials"
],
"type": "string"
},
"url": {
"description": "The URL to download the resource.",
"type": "string"
}
}
},
"AuditTrail": {
"description": "Audit trail.",
"type": "object",
"properties": {
"certificate": {
"description": "PEM encoded certificate used to identify the user.",
"type": "string"
},
"events": {
"description": "Events raised for the current session.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdSessionEvent"
}
}
}
},
"identification-v2Error": {
"description": "Error details.",
"type": "object",
"properties": {
"message": {
"description": "An error message providing details about the error.",
"type": "string"
},
"code": {
"description": "The error code reported.",
"type": "string"
},
"providerCode": {
"description": "The error code reported from the eID provider that was used.",
"type": "string"
}
}
},
"IdSessionEvent": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"eventType": {
"$ref": "#/definitions/IdSessionEventType"
},
"timestamp": {
"format": "date-time",
"type": "string"
},
"eventData": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"IdSessionEventType": {
"enum": [
"success",
"failure",
"information"
],
"type": "string"
},
"PaginatedDataDto`1": {
"type": "object",
"properties": {
"limit": {
"format": "int32",
"description": "The limit of the current paging options.",
"type": "integer"
},
"nextCursor": {
"description": "The cursor to send to the endpoint to receive the next batch of responses.",
"type": "string"
},
"data": {
"description": "An array containing the actual response elements.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdSession"
}
}
}
},
"IdSessionCreate": {
"required": [
"flow"
],
"type": "object",
"properties": {
"allowedProviders": {
"description": "A list of eID providers that can be used for identification. If not specified, the user will be able to choose from all eID's associated with your Idfy account.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/IdProviderType"
}
},
"language": {
"description": "The language to use for the identification process. Defaults to `en` (english).",
"enum": [
"en",
"no",
"sv",
"da"
],
"type": "string"
},
"flow": {
"description": "The type of flow to use.",
"enum": [
"redirect",
"iframe",
"headless"
],
"type": "string"
},
"include": {
"description": "Request additional information about the user.",
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/definitions/Include"
}
},
"redirectSettings": {
"$ref": "#/definitions/identification-v2RedirectSettings"
},
"iframeSettings": {
"$ref": "#/definitions/IframeSettings"
},
"externalReference": {
"description": "Your external reference for the session.",
"maxLength": 50,
"type": "string"
},
"ui": {
"$ref": "#/definitions/UiSettings"
},
"prefilledInput": {
"$ref": "#/definitions/PrefilledInput"
}
},
"example": {
"allowedProviders": [
"no_bankid_mobile",
"no_bankid_netcentric"
],
"language": "en",
"flow": "redirect",
"include": [
"name",
"date_of_birth",
"nin"
],
"redirectSettings": {
"successUrl": "https://example.com/success",
"abortUrl": "https://example.com/abort",
"errorUrl": "https://example.com/error"
},
"externalReference": "123456789"
}
}
},
"tags": [
{
"name": "Idfy Admin API Status",
"x-displayName": "Status"
},
{
"name": "Idfy.Validation Norwegian BankID",
"x-displayName": "Norwegian BankID"
},
{
"name": "Idfy Settings Status",
"x-displayName": "Status"
},
{
"name": "Idfy Identification v2 Languages",
"x-displayName": "Languages"
},
{
"name": "Identification Endpoint",
"description": "This endpoint enables authentication/identification through multiple identity providers such as Norwegian BankID, Swedish BankID and NemID.\n## Last update \n Last build date for this endpoint: 19.03.2020"
},
{
"name": "Signature API Endpoint",
"description": "Sign contracts, declarations, forms and other documents using digital signatures."
},
{
"name": "Information Services Endpoint",
"description": "This endpoint offers a lot of useful extra information including credit checks, signature / prokura checks and information regarding persons and companies.\r\n\n## Last update \n Last build date for this endpoint: 13.12.2018"
},
{
"name": "Secure Share Endpoint",
"description": "This endpoints enables secure sharing with multiple e-ids offered for login"
},
{
"name": "Notification Endpoint",
"description": "This endpoint lets you manage events that are raised when something happens in your account.\r\n"
},
{
"name": "Deposit Endpoint"
},
{
"name": "Admin API Endpoint",
"description": "In this API you can manage your account details, logo, styling or manage your openid / oauth api clients. If you are a dealer you can also manage the accounts registered to this dealer. Contact support to get started with the API as a dealer"
},
{
"name": "JWT Endpoint"
},
{
"name": "Text Endpoint",
"description": "This endpoint lets you customize the texts used by various Idfy services."
},
{
"name": "Validation Endpoint",
"description": "In this API you can validate signatures from the following electronic IDs (e-ID)
\n\t• Norwegian BankId (SDO)
\n\n## Last update\n[LastUpdate]\n## Last update \n Last build date for this endpoint: 12.03.2018"
},
{
"name": "MerchantSign Endpoint",
"description": "This endpoint lets you sign documents with a merchant signature.\n## Last update \n Last build date for this endpoint: 04.06.2018"
},
{
"name": "Settings Endpoint",
"description": "Settings API"
},
{
"name": "Identification v2 Endpoint",
"description": "This endpoint enables identification through multiple identity providers such as Norwegian BankID, Swedish BankID and NemID."
}
],
"swagger": "2.0",
"info": {
"version": "1",
"title": "Idfy API Reference",
"description": "# Introduction\nThe Idfy API is a RESTful API that uses the OAuth 2.0 protocol for authorization. All request and response bodies are formatted in JSON.\n\n# Getting started\n\n## Get an account\nTo use the API you need an account at Idfy. You can get a free test account by signing up through our [onboarding site](https://onboard.idfy.io).\n\n## Support\nWe’re here to help! Get in touch with support at support@idfy.io and we’ll get back to you as soon as we can.\n\n# Authentication\nThis API uses OAuth2 for authentication. OAuth2 - an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications. Be sure to use `client_credentials` as grant type when connecting to this API. \n\n## Obtaining an access token\n\nAn access token can be obtained by making a request to the OAuth2 token endpoint.\n\nThe request must include the following parameters:\n\n| Parameter | Value |\n|----------|----------|\n| `grant_type` | The type of grant used to authenticate the request. In this case: `client_credentials`. |\n| `scope` | Space-delimited list of requested scope permissions. |\n\nExample:\n\n```\nPOST https://api.idfy.io/oauth/connect/token\nContent-Type: application/x-www-form-urlencoded\nAuthorization: Basic Y2xpZW50SWQ6Y2xpZW50U2VjcmV0\n \ngrant_type=client_credentials\nscope=document_read\n```\n\n**Note**: This request must authenticate using HTTP basic authentication with your *Client Id* as the username and *Client Secret* as the password. The format is the base-64 encoded string `client_id:client_secret`. \n\nIf your credentials are valid, the server will respond with a JSON body containing the access token and its expiration time:\n```\n{\n \"access_token\": \"xxxxx.yyyyy.zzzzz\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n```\n\nYou can now store and use the access token to make authenticated requests by passing it as an authentication header:\n\n`Authorization: Bearer xxxxx.yyyyy.zzzzz`\n\nYou can read more about OAuth2 [here](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2).\n\n# REST API\n\n## HTTP status codes\n* `200 OK`: The request was successful.\n* `201 Created`: A new resource was successfully created.\n* `204 No content`: The request was successful but returns no body.\n* `400 Bad request`: The request was invalid, often due to missing a required parameter.\n* `401 Unauthorized`: Authentication failed due to invalid credentials.\n* `402 Payment Required`: The endpoint is not accessible in your current subscription. Contact sales@idfy.io.\n* `403 Forbidden`: Authorization failed due to insufficient scope/access.\n* `404 Not found`: The specified resource does not exist.\n* `422 Unprocessable Entity`: The server understood the request, but was unable to process it due to a business or logical error (For example creating an XML signature with Swedish BankID which is not supported).\n* `429 Too Many Requests`: The request was blocked due to rate limiting.\n* `500 Internal Server Error`: An internal server error occured.\n* `503 Service Unavailable`: A third party service that this endpoint depends on caused an error or is unavailable.\n\n## HTTP verbs\n* `GET`: Retrieves a resource or lists resources.\n* `POST`: Creates or exceutes a commandand on a resource.\n* `PUT`: Replaces a resource.\n* `PATCH`: Partially updates a resoruce.\n* `DELETE`: Deletes a resoure.\n\n## Formats\nThe Idfy API only supports JSON format. All requests must use the `Content-type` header set to `application/json`. The JSON will use camelCasing. All requests must use the UTF-8 encoding, and all responses will be in UTF-8.\nAll file downloads will be a standard HTTP download result.\n\n## Idempotent Requests\nThe APIs support idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a new document fails due to a network connection error, you can retry the request with the same ExternalId to guarantee that only a single document/identification is created.\n\n## Compatibility\nThe Idfy APIs do change from time to time, but all changes will follow strict rules in order to keep the APIs backward compatible. All new fields will be optional, and if large changes are required a new endpoint will be created. If an endpoint is being deprecated, all customers will be notified well in advance.\n\n## Pagination (linked lists)\nWhen using paging the list will be wrapped in a linked list object. The data contains the list-data in the result. There will also be navigation links for next, first, last and previous page. The total amount of results (size) will also be inlcuded.\nExample:\n```json\n{\n \"offset\": 0,\n \"limit\": 2,\n \"size\": 45,\n \"links\": {\n \"next\": \"https://api.idfy.io/signature/documents/summary?limit=2&offset=2\",\n \"first\": \"https://api.idfy.io/signature/documents/summary?limit=2\",\n \"last\": \"\",\n \"previous\": \"\"\n },\n \"data\": [\n {\n \"id\": \"2519011552909132317BrJ6VqOrcBYfwmgQ2eypM5XP7DEbCm8\",\n \"name\": \"Bruce Wayne\",\n \"status\": \"SUCCESS\",\n \"clientIp\": \"192.168.1.1\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36\",\n \"identityProviderType\": \"NO_BANKID_WEB\",\n \"language\": \"NO\",\n \"externalid\": \"gtWEH8euBHeSWPTcjwB0Bg5o1mjsH106wmjTDMxoFnadzvNSsnSSY0zbJTpy\",\n \"timestamp\": \"2017-07-19T18:29:53.7550972Z\",\n \"iframe\": false,\n \"socialSecurityNumber\": false\n },\n {\n \"id\": \"2519011552909132317BrJ6VqOrcBYfwmgQ2eypM5XP7DEbCm8\",\n \"name\": \"Joker\",\n \"status\": \"ERROR\",\n \"clientIp\": \"192.168.1.1\",\n \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36\",\n \"identityProviderType\": \"FI_FTN\",\n \"language\": \"NO\",\n \"externalid\": \"gtWEH8euBHeSWPTcjwB0Bg5o1mjsH106wmjTDMxoFnadzvNSsnSSY0zbJTpy\",\n \"errorcode\": \"TIMEOUT\",\n \"timestamp\": \"2017-07-19T18:29:53.7550972Z\",\n \"iframe\": false,\n \"socialSecurityNumber\": false\n }\n ]\n}\n```\n\n## HTTP response headers\nAll API requests have some standard HTTP headers:\n* `X-Idfy-Environment`: (test or prod) this header tells you if you are talking to the test or the production environment.\n* `X-Idfy-AccountId`: The Idfy accountID for the request.\n* `RequestId`: Each API request has an associated request identifier. You will also be able to use this to search in the logs in the Idfy dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n\n",
"termsOfService": "https://developer.idfy.io/terms",
"contact": {
"name": "Idfy Norge AS",
"url": "https://www.idfy.io",
"email": "support@idfy.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"host": "api.idfy.io",
"basePath": "/",
"schemes": [
"https"
],
"securityDefinitions": {
"oauth2": {
"type": "oauth2",
"description": "OAuth 2 flow: Application Grant/Client Credentials",
"flow": "application",
"tokenUrl": "https://api.idfy.io/oauth/connect/token",
"scopes": {
"addons": "Grants access to information endpoint.",
"account_read": "Grants read-only access to admin endpoint.",
"account_write": "Grants write access to admin endpoint.",
"oauth_write": "Grants read/write access to manage OAuth clients",
"openid_write": "Grants read/write access to manage OpenID clients",
"account-create": "Account create",
"identify": "Grants read/write access to identification endpoint.",
"document_read": "Grants read-only access to documents.",
"document_write": "Grants write access to documents.",
"document_file": "Grants access to download documents.",
"form_write": "Grants write access to forms.",
"form_read": "Grants read-only access to forms.",
"form_file": "Grants access to download forms.",
"event": "Grants full access to notification endpoint.",
"invoice": "Invoice",
"analytics": "Analytics",
"audit_root": "Grants full access to audit endpoint.",
"audit_read": "Grants read-only access to audit endpoint.",
"audit_write": "Grants write access to audit endpoint.",
"merchantsign": "Grants full access to merchant signature endpoint.",
"validation": "Grants full access to validation endpoint.",
"validation_ssn": "Grants full access to validation endpoint with social security number.",
"text_read": "Grants read-only access to text endpoint.",
"text_write": "Grants write access to text endpoint.",
"deposit_read": "Grants read access to the deposit API.",
"deposit_write": "Grants write access to the deposit API.",
"share_read": "Grants read access to the Share API.",
"share_write": "Grants write access to the Share API.",
"person_monitor_read": "Grants read access to the person API monitor resources.",
"person_monitor_write": "Grants write access to the person API monitor resources.",
"self_declaration_read": "Grants read access to the self declaration API resources.",
"self_declaration_write": "Grants write access to the self declaration API resources."
}
}
},
"x-tagGroups": [
{
"name": "Identification",
"tags": [
"Identification Endpoint",
"Identification Session",
"Log",
"Norwegian BankID"
]
},
{
"name": "Signature API",
"tags": [
"Signature API Endpoint",
"Attachments",
"Documents",
"Files",
"Notifications",
"SignatureMethods",
"Signers",
"Stats",
"Themes"
]
},
{
"name": "Information Services",
"tags": [
"Information Services Endpoint",
"Aml",
"Business",
"BusinessRegistry",
"GeoData",
"Lei",
"MobileInfo",
"Person",
"Report",
"SignatureRolesCheck"
]
},
{
"name": "Secure Share",
"tags": [
"Secure Share Endpoint",
"Recipients",
"Share"
]
},
{
"name": "Notification",
"tags": [
"Notification Endpoint",
"Events",
"Webhooks"
]
},
{
"name": "Deposit",
"tags": [
"Deposit Endpoint",
"Personal"
]
},
{
"name": "Admin API",
"tags": [
"Admin API Endpoint",
"Account",
"OAuthAPIClient",
"OpenID",
"Template",
"Dealer",
"Invoice"
]
},
{
"name": "JWT",
"tags": [
"JWT Endpoint",
"Jwt"
]
},
{
"name": "Text",
"tags": [
"Text Endpoint",
"Language Sets",
"Languages",
"Translations"
]
},
{
"name": "Validation",
"tags": [
"Validation Endpoint",
"Idfy.Validation Norwegian BankID"
]
},
{
"name": "MerchantSign",
"tags": [
"MerchantSign Endpoint",
"Signature"
]
},
{
"name": "Settings",
"tags": [
"Settings Endpoint",
"Idfy Settings Status"
]
},
{
"name": "Identification v2",
"tags": [
"Identification v2 Endpoint",
"ID Providers",
"Idfy Identification v2 Languages",
"Sessions"
]
}
]
}