Appearance

API Specification ​

v1.0.1

Mobile ID REST API​

Download OpenAPI Document

Mobile ID API for requesting mobile signatures.

Servers​

https://mobileid.swisscom.com

Send a Mobile Signature Service request​

POST
/rest/service/sign

Request Body​

application/json
JSON
{
"MSS_SignatureReq": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "1",
"MinorVersion": "2",
"MobileUser": {
"MSISDN": "+2280112xxx"
},
"MessagingMode": "string",
"SignatureProfile": "http://mid.swisscom.ch/STK-LoA4",
"TimeOut": "string",
"DataToBeSigned": {
"MimeType": "text/plain",
"Encoding": "UTF-8",
"Data": "Please sign this"
},
"AdditionalServices": [
{
"Description": "string",
"UserLang": {
"Value": "DE"
},
"App2App": {
"RedirectUri": "myapp://example"
}
}
]
}
}

Responses​

A Mobile Signature response has been received. Check the StatusCode for details. In asynchorous mode this will never contain a signature, and contains an MSSP_TransId instead.

application/json
JSON
{
"MSS_SignatureResp": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "1",
"MinorVersion": "1",
"MobileUser": {
"MSISDN": "+2280112xxx"
},
"MSSP_TransID": "h44okl",
"MSS_Signature": {
"Base64Signature": "MIIIdwYJKoZIhvc..."
},
"Status": {
"StatusMessage": "SIGNATURE",
"StatusCode": {
"Value": "500"
}
},
"SignatureProfile": "http://mid.swisscom.ch/STK-LoA4",
"ServiceResponses": [
{
"Description": "string",
"Geofencing": {
"Country": "CH",
"Accuracy": "16",
"DeviceConfidence": "1.0",
"LocationConfidence": "1.0",
"Timestamp": "2021-01-01T11:00:00.000+01:00",
"ErrorCode": "100",
"ErrorMessage": "Geofencing feature disabled"
},
"App2App": {
"AuthUri": "mobileid://auth?mobile_auth_redirect_uri=myapp%3A%2F%2Fapp.open%23access_token%3DABCD&session_token=32ffc297-0N5F0yEk2ArMZjFhBWPb4Uifwbk1f3p9ciAURd_QhUQ9e&user_id=32ffc297-ac33-4be2-b3f4-42588502ea0f"
},
"SubscriberInfo": {
"Details": [
{
"id": "1901",
"value": "26200"
}
]
}
}
]
}
}

Samples​

Request the Mobile Signature Service status of an asynchronous signature request.​

POST
/rest/service/status

Request Body​

application/json
JSON
{
"MSS_StatusReq": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"MSSP_TransID": "h4iof"
}
}

Responses​

Mobile Signature Service response has been received. Check the StatusCode for details.

application/json
JSON
{
"MSS_StatusResp": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"MobileUser": {
"MSISDN": "+2280112xxx"
},
"MSS_Signature": {
"Base64Signature": "MIIIdwYJKoZIhvc..."
},
"Status": {
"StatusMessage": "SIGNATURE",
"StatusCode": {
"Value": "500"
}
},
"ServiceResponses": [
{
"Description": "string",
"Geofencing": {
"Country": "CH",
"Accuracy": "16",
"DeviceConfidence": "1.0",
"LocationConfidence": "1.0",
"Timestamp": "2021-01-01T11:00:00.000+01:00",
"ErrorCode": "100",
"ErrorMessage": "Geofencing feature disabled"
},
"App2App": {
"AuthUri": "mobileid://auth?mobile_auth_redirect_uri=myapp%3A%2F%2Fapp.open%23access_token%3DABCD&session_token=32ffc297-0N5F0yEk2ArMZjFhBWPb4Uifwbk1f3p9ciAURd_QhUQ9e&user_id=32ffc297-ac33-4be2-b3f4-42588502ea0f"
},
"SubscriberInfo": {
"Details": [
{
"id": "1901",
"value": "26200"
}
]
}
}
]
}
}

Samples​

Send the Mobile Signature Receipt. You can send the Receipt after a successful Mobile Signature.​

POST
/rest/service/receipt

Request Body​

application/json
JSON
{
"MSS_ReceiptReq": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"MSSP_TransID": "h4iof",
"Message": {
"MimeType": "text/plain",
"Encoding": "UTF-8",
"Data": "Receipt message"
},
"MobileUser": {
"MSISDN": "+2280112xxx"
},
"Status": {
"StatusCode": {
"Value": "100"
},
"StatusDetail": {
"ReceiptRequestExtension": {
"ReceiptMessagingMode": "string",
"ReceiptProfile": {
"Language": "DE",
"ReceiptProfileURI": "http://mss.swisscom.ch/synch"
},
"UserAck": "string"
}
}
}
}
}

Responses​

Mobile Signature Service Receipt request has been send. Check the Status for details.

application/json
JSON
{
"MSS_ReceiptResp": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"Status": {
"StatusCode": {
"Value": "100"
},
"StatusDetail": {
"ReceiptResponseExtension": {
"ReceiptMessagingMode": "string",
"UserAck": "string",
"ClientAck": "string",
"NetworkAck": "string",
"UserResponse": "{"status":"OK"}"
}
}
}
}
}

Samples​

Query Mobile Signature Service Profile of an user.​

POST
/rest/service/profile

Request Body​

application/json
JSON
{
"MSS_ProfileReq": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"Params": "sscds state certs pinstatus rcstatus aastatus",
"MobileUser": {
"MSISDN": "+2280112xxx"
}
}
}

Responses​

Profile Query succeeded and user is eligible for Mobile Signature Service. See the Status element for profile details of the user.

application/json
JSON
{
"MSS_ProfileResp": {
"AP_Info": {
"AP_ID": "your AP_ID",
"AP_PWD": "your AP_PWD",
"AP_TransID": "REF0101120000",
"Instant": "2021-04-01T11:00:00.000Z"
},
"MSSP_Info": {
"MSSP_ID": {
"URI": "http://mid.swisscom.ch/"
},
"Instant": "2021-04-07T11:00:00.100Z"
},
"MajorVersion": "string",
"MinorVersion": "string",
"SignatureProfile": [
"http://mid.swisscom.ch/STK-LoA4"
],
"Status": {
"StatusCode": {
"Value": "100"
},
"StatusDetail": {
"ProfileQueryExtension": {
"MobileUser": {
"AutoActivation": true,
"RecoveryCodeCreated": true
},
"Sscds": {
"App": [
{
"MobileUserCertificate": [
{
"Algorithm": "RSA",
"State": "ACTIVE",
"X509Certificate": [
"X509_BASE64_CERT_USER"
],
"X509SubjectName": [
"X509_BASE64_SUBJECT_USER"
]
}
],
"PinStatus": {
"Blocked": true
},
"State": "ACTIVE",
"CardDetails": {
"Mcc": "228",
"Mnc": "01",
"Network": "Swisscom"
}
}
],
"Sim": {
"MobileUserCertificate": [
{
"Algorithm": "RSA",
"State": "ACTIVE",
"X509Certificate": [
"X509_BASE64_CERT_USER"
],
"X509SubjectName": [
"X509_BASE64_SUBJECT_USER"
]
}
],
"PinStatus": {
"Blocked": true
},
"State": "ACTIVE",
"CardDetails": {
"Mcc": "228",
"Mnc": "01",
"Network": "Swisscom"
}
}
}
}
},
"StatusMessage": "REQUEST_OK"
}
}
}

Samples​

Powered by VitePress OpenAPI