Checking the status of orders

When an order has been processed, it is of course necessary to check the status of the order. This usually happens after the OnFinal webhook has been sent.

Please do not try to query the order status and result data synchronously from the webhook itself. To keep the system responsive, it is expected that the call completes under 5 seconds.

Final status codes vs. non-final status codes

A status code can be final or non-final. Final in this case means, that the process has come to a natural end and the user will not be able to try it again using the same order. In case of a positive identification / signing, result data will be available (with a special exception in case you requested us to sign ident PDF documents, these will only be available after status 80 has been set).

Since eSign and identification orders work differently, a different set of status codes is considered final.

Extended status codes vs. normal status codes

Each status code is either a normal one or an extended one. Normal (or non-extended) ones are used to inform you about the major steps an order took while being processed.

Extended status codes are used to provide you with a more detailed and more in-depth view of how the order has been process by us.

The default variant of getStatus will only return normal status codes. If you want to receive the extended ones as well, you need to use the ExtendedList variant of getStatus. The normal status codes will be included as well.

List of status codes

Please take note, that not all codes are relevant for every product. For example, most codes above 10000 are specific to autoID.

The status codes 29 (uncorrectable error in external systems) and 139 (correctable error in external systems) are especially relevant when you intend to implement a customer-side eSign processing according to Customer-side eSign Processing.

Both errors refer to errors in external systems, here namely the systems of the TSP.

If you encounter status code 29 in such a process, there will be no way to finish the order and a new order needs to be created. Code 139 indicates a possibly correctable error.

Kind	Description / Meaning	Final non-eSign	Final eSign	Extended
6	Identification positively conducted	Y	N	N
7	E-mail has been sent	N	N	Y
11	Order is being processed by QM	N	N	N
12	Customer could not be reached by phone	N	N	N
14	Document sent to client	N	N	N
16	Identification refused by customer	Y	Y	N
17	Identification negatively conducted	Y	Y	N
21	The processing was aborted	N	N	N
22	The processing was terminated	Y	Y	N
23	Document verified	N	N	Y
24	Document erroneous in postprocessing	N	N	Y
25	Order initialized	N	N	Y
29	Uncorrectable error in external system	Y	Y	Y
30	Order has been processed by QM	N	N	N
49	eID IDapp link created	N	N	Y
50	eID IDapp request	N	N	Y
51	eID data gathered	N	N	Y
53	eID aborted/not possible	N	N	Y
54	Support	N	N	Y
55	Customer could not be reached by phone	N	N	N
56	Phone number is incorrect	N	N	N
57	Identification not possible, customer was repeatedly not present at appointments	N	N	N
58	Identification refused by customer by phone	Y	Y	N
63	Cancellation	Y	Y	N
68	Change of procedure to Shop	N	N	N
70	Spoken on answering machine	N	N	Y
71	SMS sent	N	N	Y
73	Change of procedure to Video	N	N	N
74	Change of procedure to eiD	N	N	Y
75	Video identification conducted	N	N	N
77	Video identification in waiting room	N	N	Y
78	Video identification call has begun	N	N	Y
79	Video identification call has been left	N	N	Y
80	Identification data ready for pick-up	N	N	N
83	Document signature request	N	N	Y
84	Document signed	N	Y	Y
87	Request for new Order	N	N	N
89	Possible fraud attempt by customer	N	N	Y
94	eSign Account created	N	N	Y
95	eSign Account verified	N	N	Y
96	eSign Account already exists	N	N	Y
98	Change of procedure to autoID	N	N	N
99	TimeOut	Y	Y	N
100	TimeOut after identification	Y	Y	N
101	eSign documents verified and hashes generated	N	N	Y
102	eSign document preview	N	N	Y
103	eSign aborted	N	Y	N
104	Video ident waiting for verification	N	N	Y
105	Ident is under verification	N	N	Y
106	Video Ident verification positive	N	N	Y
107	Video Ident verification data error found	N	N	Y
108	Video Ident verification negative	N	N	Y
109	autoID process not possible	N	N	Y
139	Correctable error in external system, please try	N	N	Y
153	autoId abort	N	N	Y
10000	no address verification	N	N	Y
10001	no additional document	N	N	Y
10002	customer without identification document	N	N	Y
10003	photo resolution too low to read text	N	N	Y
10004	customer not present	N	N	Y
10005	customer less than minimum age	N	N	Y
10006	poor lighting conditions	N	N	Y
10007	identification document unrecognisable	N	N	Y
10008	Other cancellation reasons	N	N	Y
10009	identical selfies or images	N	N	Y
10010	Paper driving licence not all pages visible in the photo	N	N	Y
20000	Photo in document does not match person	N	N	Y
20001	Document looks forged	N	N	Y
20002	Repetitive fraud attempt	N	N	Y
20003	Fraud attempt	N	N	Y
20004	Negative according to test criteria	N	N	Y
20005	Document not supported	N	N	Y
20006	Document expired	N	N	Y
20007	Document damaged	N	N	Y
20008	Date of issue Driving licence class B not readable	N	N	Y
20009	Driving licence expired	N	N	Y
20010	Driving licence not supported	N	N	Y
20011	Driving licence damaged	N	N	Y

Sub-Status Codes

For some specific status codes, a more detailed view is available. The details are only included in the response if the appropriate variant of the method is called.

Keep in mind that not all status codes have sub-status codes and even status codes that have sub-status codes might not always carry a sub-status.

The list of sub-status codes might grow at any point in time, so do not rely on the list being exhaustive.

Kind	SubKind	Description / Meaning
6	19	Order with signed ident data
7	10	User left video call
7	12	Invitation to identification
7	21	Temporary cancellation / technical abort with retry option
7	24	Reminder
7	25	Final message
7	28	TAN
7	33	Shop invitation
7	37	Signature re-entry link
7	55	Identification appointment
7	58	eSign reminder
17	43	Document not supported
17	48	Identification criteria
17	61	TAN tried too often
17	72	Identification document photo does not match person
17	73	Identification document invalid, expired, non-existent, or not permitted
17	74	Address confirmation document invalid, expired, non-existent, or not permitted
17	75	Driver's license invalid, expired, non-existent, or not permitted
21	14	Unable to establish video connection to user
21	15	Resolution too low to conduct video identification
21	18	Unable to establish audio connection to user
21	22	User not present
21	27	Unsupported identification document
21	29	Identification data does not match
21	32	User without identification document
21	34	User speaks no supported language
21	36	Other reasons
21	38	Identification document damaged
21	39	Lighting conditions too poor to conduct identification
21	42	Identification document expired
21	47	Negative due to identification criteria
21	50	User unable to show any document
21	53	Type of identification document could not be determined
21	54	No address verification possible
23	20	Order with signed ident data
23	41	As configured
29	63	The certificate associated with the key has expired
29	64	Existing Holder with different person data
29	65	Mobile number already assigned to another holder with a certificate that is still valid and has not revoked
29	76	Mobile number already assigned to another holder till a specific date
58	30	User is no longer interested in product
71	16	TAN
71	17	Namirial TAN
71	23	autoID
71	44	Sign-Me password
71	46	Reference
71	49	AES TAN
71	56	eSign re-entry TAN
71	62	eID TAN
103	79	PDF hashing failed
139	66	Sending OTP TAN failed
153	176	Document is blurry and mandatory data cannot be read due to the blur.
153	177	Document has glare and mandatory data cannot be read due to the glare.
153	178	Pictures of the document are dark and it is not possible to read the mandatory data or verify the authenticity of the document.
153	179	Mandatory data is covered by the user while taking the picture.
153	180	Document is positioned at such an angle that mandatory data cannot be read or document cannot be verified.
153	181	Any other reason due to which mandatory data cannot be read.
153	182	Document used during the identification is not supported for the customer's use case.
153	183	Document used during the identification is expired.
153	184	Wrong side of the document is scanned during the process.
153	185	Document is worn out. Either data cannot be read out or the document cannot be verified.
153	186	Document has such stickers which are not acceptable and the document used is considered as damaged document.
153	187	Document has text written over it which makes the document not readable or not verifiable. If the sticker is legit one and added by the authorities while issuing the document then the document will be acceptable and not cancelled due to this reason..
153	188	Document used during the identification is broken.
153	189	Any other reason for a damaged document.
153	190	Security features of the document are not visible because user did not move the document correctly.
153	191	Security feature video is too short to detect if there are holograms in the document.
153	192	Security feature video cannot be played for the agent to review holograms.
153	193	Any other issues with the security feature video.
153	194	Photo quality of the additional document in the process is not acceptable.
153	195	Additional document used in the identification process is severely outworn, written or drawn on, ripped or broken.
153	196	Addiitonal document used in the identification process is an expired document.
153	197	Additional document like Drivers License is missing in the identification process but it was required.
153	198	Any other issues with the additional document used in the identification process.
153	199	Any other issues with the document used in the identification process.
153	200	Customer needs proof of address from the user as the additional document but user did not provide it in the identification process.
153	201	User has covered the face during the face comparison process unintentionally like wearing the face mask.
153	202	Selfie taken by the user is blurry and cannot be used to compare the face with the identification document.
153	203	Photo of the user on the ID document has glares and selfie cannot be compared with it.
153	204	Selfie taken by the user is too dark to compare the face of the person with the photo on the identification document.
153	205	Selfie taken by the user is on such an angle that it is not possible to compare it with the photo on the identification document.
153	206	Any other issues with the selfie which restrict ident sepcialist to compare the selfie of the user with the photo on the identification document.
153	207	Due to a technical reason, ident specialist cannot finish the identity verification process.
153	208	Due to a technical reason, ident specialist cannot see the data submitted by the user in the identification process.
153	209	Any other reason due to which the identification process cannot be completed by the ident specialist.

Method and URL

[GET] https://customer.identity.tm/api/2.10/getStatus/[OrderID]
[GET] https://customer.identity.tm/api/2.10/getStatus/[OrderID]/IncludeSubKind
[GET] https://customer.identity.tm/api/2.10/getStatus/[OrderID]/ExtendedList
[GET] https://customer.identity.tm/api/2.10/getStatus/[OrderID]/ExtendedList/IncludeSubKind

Variants

Variant	Description
Default	Return only normal status codes
IncludeSubKind	Also return sub-status codes
ExtendedList	Also return extended status codes

Response Data

Element	Parent	Type	Len	Occ	Description
OrderID	[ROOT]	S	20	Y	Requested OrderID
Ref	[ROOT]	S	100	Y	Corresponding Ref
Executed	[ROOT]	DTS		Y	Timestamp at which the request has been executed
Status	[ROOT]	A		Y	Array of status codes
Kind	Status	N		Y	Status code
SubKind	Status	N		Dep	Only when /IncludeSubKind variant of the method is used
Time	Status	DTS		Y	Timestamp at which status has been set
Text	Status	S		Dep	Explanatory text

HTTP Codes

200 OK, JSON document in body

400 Bad request, error description in body

401 Authentication failed, please check username and password

404 Order not found

Example Request

[GET] https://customer.identity.tm/api/2.0/getStatus/99921269855041/ExtendedList

Example Response

{
  "OrderID": "99921269855041",
  "Ref": "Sign-me_Account_Creation_Test",
  "Executed": "2018-09-05T11:06:21+02:00",
  "Status": [
    {
      "Kind": 25,
      "Time": "2018-09-05T10:53:59+02:00"
    },
    {
      "Kind": 71,
      "Time": "2018-09-05T10:54:00+02:00",
      "Text": "signme Passwort"
    },
    {
      "Kind": 94,
      "Time": "2018-09-05T10:54:00+02:00"
    },
    {
      "Kind": 77,
      "Time": "2018-09-05T10:56:37+02:00"
    },
    {
      "Kind": 78,
      "Time": "2018-09-05T10:56:45+02:00"
    },
    {
      "Kind": 71,
      "Time": "2018-09-05T10:59:11+02:00",
      "Text": "TAN"
    },
    {
      "Kind": 75,
      "Time": "2018-09-05T11:06:21+02:00"
    },
    {
      "Kind": 6,
      "Time": "2018-09-05T11:06:21+02:00"
    },
    {
      "Kind": 23,
      "Time": "2018-09-05T11:06:21+02:00"
    },
    {
      "Kind": 95,
      "Time": "2018-09-05T11:09:51+02:00"
    }
  ]
}