seal.ID quick start guide

Step 1: Create a document-basket

POST https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/document-baskets

With the following request a document-basket and an identification case is created:

If firstName or lastName is set to "Xtesthappy" a testbot will be triggered to simulate the happy case of a successful review.

{
	"ubiSignProfileId": 2,
	"ubiIdConfiguration": {
		"doIdentification": "ALWAYS",
		"ubiIdProfileId": 2
	},
	"signers": {
		"signersEvidence": [
			{
				"firstName": "Xtesthappy",
				"lastName": "Muster",
				"language": "de",
				"mobileCountryCode": 41,
				"mobilePhoneNumber": 791234567
			}
		]
	}
}

In the response, the documentBasketId and for each added signer a signerId and and ubiIdCaseId are returned.

{
    "extCaseId": null,
    "extApplication": null,
    "documentBasketId": "199bd416-0614-417f-ac3c-d5a925a35856",
    "documentBasketStatus": "OUTSTANDING",
    "signers": [
        {
            "extApplication": null,
            "ubiIdCategory": null,
            "extCaseId": null,
            "ubiIdCaseId": "55065bf1-1774-4e98-ac2b-ba975c0d8b33",
            "signerId": "eec029fe-ea12-45fc-b16c-824b1dd69a3f",
            "extPersonId": null,
            "lastName": "Muster",
            "firstName": "Hans",
            "dateOfBirth": null,
            "evidenceIdentifier": null,
            "nationality": null,
            "issuerCountry": null,
            "ubiIdUrl": "https://sandbox-autoid.ubiid.ch/scan/start?scheduled-case-id=55065bf1-1774-4e98-ac2b-ba975c0d8b33&language=de",
            "ubiSignUrl": "https://sandbox-autoid.ubiid.ch/docs/sign/start?signerid=eec029fe-ea12-45fc-b16c-824b1dd69a3f&language=de&nonce=J5Qoeeo31Q8Ji4KHMuQxYQ",
            "expiration": "2024-05-28T16:33:12",
            "ubiIdStatus": "SCHEDULED",
            "qtspStatus": "NO_REGISTRATION",
            "signingStatus": "OUTSTANDING"
        }
    ],
    "ubiSignExpirationTimestamp": "2024-05-28T16:33:12",
    "waitForUploadDocument": false
}

Step 2: Upload a document

POST https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/document-baskets/{documentBasketId}/documents

Sample request:

metadata: {"displayName": "Sample contract" }
file: {upload file}

Sample response:

{
    "id": "4e5f27a5-e22c-43d6-9115-d577e1ca0480",
    "extDocumentId": null,
    "displayName": "Sample contract",
    "signaturePlacements": []
}

Step 3: Do Identification and signing process

Open "ubiIdUrl" from response of step 1 in a web browser and go through the process.

It is recommended to do the scanning process in a mobile phone. If the link is opened in a desktop browser a QR code is displayed before the scanning. The QR code can be scanned with a mobile phone to do the AutoIdent.

Step 4: Retrieve result of identification and signing

A webhook url for identification and a separate one for signing needs to be provided by the customer. Once these 2 urls are configured in the account a webhook notification will be sent in the following occasions:

• when creating the document-basket and the identification case

• on each status update of each identification and of each signer

Get Identification files:

GET https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/id-cases/{ubiIdCaseId}/files.zip

Get Identification data:

GET https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/id-cases/{ubiIdCaseId}

Get signed documents:

GET https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/document-baskets/{documentBasketId}/files.zip

Get status of document-basked and signers:

GET https://sandbox-autoid.ubiid.ch/api/v1/{TenantId}/document-baskets/{documentBasketId}