Skip to main content

Mobile Phone Number Verification

All these operations need to be enabled for your account. They work on previously created orders. See Creating Orders for details.

In case you set up a deeply integrated PoS identification and possibly signing, it will be necessary to verify the user's control over a mobile device identified by a mobile phone number. Instead of implementing that completely on your own, you can use our services to make handling easier.

Process order and start verification​

Use this function to start verification process. A TAN will be sent to the user.

Requirements​

This function must be enabled for your account.

Method and URL​

[POST] https://customer.identity.tm/api/2.10/requestPhoneVerification/[OrderID]

HTTP Codes​

202 Accepted

400 Bad request, error description in body

401 Authentication failed, please check username and password

404 Order not found or already deleted

406 Invalid order state

410 Order has already been processed

Example Request​

[POST] https://customer.identity.tm/api/2.10/requestPhoneVerification/99920006C38842

Prove control over mobile phone​

Prove, that the user has control over the given mobile phone number. To do so, the TAN previously sent need to be provided.

Requirements​

This function must be enabled for your account.

Method and URL​

[POST] https://customer.identity.tm/api/2.10/provePhoneControl/[OrderID]

JSON Request Body​

ElementParentTypeLenReqDescription
tan[ROOT]S5YThe TAN the user received.

HTTP Codes​

202 Accepted

400 Bad request, error description in body

401 Authentication failed, please check username and password

404 Order not found or already deleted

409 Wrong TAN given

410 Order has already been processed

412 Process has not been started, call requestPhoneVerification first

429 Too many tries with a wrong TAN, order cancelled

Example Request​

[POST] https://customer.identity.tm/api/2.10/provePhoneControl/99920006C38842

{
  "tan": "123456"
}

Request a new TAN​

In case the TAN has not been received by the signee, you can request to send a new TAN to the signee.

Requirements​

This function must be enabled for your account.

Method and URL​

[POST] https://customer.identity.tm/api/2.10/requestResendPhoneTan/[OrderID]

HTTP Codes​

202 Accepted

400 Bad request, error description in body

401 Authentication failed, please check username and password

404 Order not found or already deleted

410 Order has already been processed

412 Process has not been started, call requestPhoneVerification first

Example Request​

[POST] https://customer.identity.tm/api/2.10/requestResendPhoneTan/99920006C38842