3GPP-based Call Authentication APIs (1.0, TS 24.229, Release 17.10.0)

Download OpenAPI specification:Download

Note: The above download will output the 3GPP-based Call Authentication APIs in OpenAPI format.

Definition of the Application Server HTTP messages and data types for signing and verification using the Ms reference point. These APIs are designed to be compliant with the referenced 3GPP specification, while also including several optional enhancements. Such enhancements may or may not be brought back into the 3GPP CT1 working group for consideration.

signing

Used to construct a PASSporT "shaken" JSON Web Token, a PASSporT "div" JSON Web Token or a PASSporT "rph" JSON Web Token. Also, referred to as the Secure Telephone Identity Authentication Service (STI-AS).

Signing (STI-AS) Request

Request Body schema: application/json

object

JSON structure of the signing request

Responses

Request samples

Content type

application/json

{"signingRequest": {"ppt": "shaken, div or rph",
"attest": "A , B or C",
"dest": {"tn": ["12155551213"
],
"uri": ["john@asterisk.com"
]
},
"iat": 1664199282,
"orig": {"tn": "12155551211",
"uri": "alice@asterisk.com"
},
"origid": "123e4567-e89b-12d3-a456-426655440000",
"rph": {"auth": ["esnet.0"
]
},
"sph": "psap-callback",
"div": {"tn": "121555551212",
"uri": "fred@example.com",
"hi": "1.1.1"
},
"profileId": "Profile-1234",
"requestId": "12378"
}
}

Response samples

Content type

application/json

Example

shaken

{"signingResponse": {"identityHeader": "eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cDovL05FVS1DMDJGRzJLN01MODU6ODA4MC9jY2lkL2F1dGhuL3YyL2NlcnRzLzExMDAxLjEwMDAxIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTcxNTU1MDAwMCJdfSwiaWF0IjoxNjQ5NTM2NTMxLCJvcmlnIjp7InVyaSI6InNpcDphbGljZUBleGFtcGxlLmNvbSJ9LCJvcmlnaWQiOiJjODcyNDU3NS1iNzgxLTExZWMtYjU3NC0wMjQyYWMxMTAwMDIifQ.piGZhwqwWaKM4cOcrDTMeFKOY5UlekVDlKZTxlge4x0ERnSe9uW4400gaoVFdpGiTOzoCt9QdSfwLV_hcmvT0g;info=<http://NEU-C02FG2K7ML85:8080/ccid/authn/v2/certs/11001.10001>;alg=ES256;ppt=\"shaken\"",
"requestId": "12378"
}
}

verification

Used to verify one or more PASSporT JSON Web Tokens (or Identity headers). Also, referred to as the STI Verification Service (STI-VS).

Verification (STI-VS) Request

Request Body schema: application/json

object

JSON structure of the verification request

Responses

Request samples

Content type

application/json

{"verificationRequest": {"identityHeader": "kjhytrciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cDovL05FVS1DMDJGRzJLN01MODU6ODA4MC9jY2lkL2F1dGhuL3YyL2NlcnRzLzExMDAxLjEwMDAxIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTcxNTU1MDAwMCJdfSwiaWF0IjoxNjQ5NTM2NTMxLCJvcmlnIjp7InVyaSI6InNpcDphbGljZUBleGFtcGxlLmNvbSJ9LCJvcmlnaWQiOiJjODcyNDU3NS1iNzgxLTExZWMtYjU3NC0wMjQyYWMxMTAwMDIifQ.piGZhwqwWaKM4cOcrDTMeFKOY5UlekVDlKZTxlge4x0ERnSe9uW4400gaoVFdpGiTOzoCt9QdSfwLV_hcmvT0g;info=<http://NEU-C02FG2K7ML85:8080/ccid/authn/v2/certs/11001.10001>;alg=ES256;ppt=\"shaken\"",
"identityHeaders": ["mjhtrrciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cDovL05FVS1DMDJGRzJLN01MODU6ODA4MC9jY2lkL2F1dGhuL3YyL2NlcnRzLzExMDAxLjEwMDAxIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTcxNTU1MDAwMCJdfSwiaWF0IjoxNjQ5NTM2NTMxLCJvcmlnIjp7InVyaSI6InNpcDphbGljZUBleGFtcGxlLmNvbSJ9LCJvcmlnaWQiOiJjODcyNDU3NS1iNzgxLTExZWMtYjU3NC0wMjQyYWMxMTAwMDIifQ.piGZhwqwWaKM4cOcrDTMeFKOY5UlekVDlKZTxlge4x0ERnSe9uW4400gaoVFdpGiTOzoCt9QdSfwLV_hcmvT0g;info=<http://NEU-C02FG2K7ML85:8080/ccid/authn/v2/certs/11001.10001>;alg=ES256;ppt=\"div\"",
"eyJhbGciOiJFUzI1NiIsInBwdCI6InNoYWtlbiIsInR5cCI6InBhc3Nwb3J0IiwieDV1IjoiaHR0cDovL05FVS1DMDJGRzJLN01MODU6ODA4MC9jY2lkL2F1dGhuL3YyL2NlcnRzLzExMDAxLjEwMDAxIn0.eyJhdHRlc3QiOiJBIiwiZGVzdCI6eyJ0biI6WyIxNTcxNTU1MDAwMCJdfSwiaWF0IjoxNjQ5NTM2NTMxLCJvcmlnIjp7InVyaSI6InNpcDphbGljZUBleGFtcGxlLmNvbSJ9LCJvcmlnaWQiOiJjODcyNDU3NS1iNzgxLTExZWMtYjU3NC0wMjQyYWMxMTAwMDIifQ.piGZhwqwWaKM4cOcrDTMeFKOY5UlekVDlKZTxlge4x0ERnSe9uW4400gaoVFdpGiTOzoCt9QdSfwLV_hcmvT0g;info=<http://NEU-C02FG2K7ML85:8080/ccid/authn/v2/certs/11001.10001>;alg=ES256;ppt=\"rph\""
],
"to": {"tn": "12155551212",
"uri": "fred@example.com"
},
"dest": {"tn": "12155551213",
"uri": "john@asterisk.com"
},
"time": 1664216863,
"from": {"tn": "12155551211",
"uri": "alice@asterisk.com"
},
"protectedHeaders": ["Diversion: sip:12155551212@10.10.100.12;reason=unknown;privacy=off",
"Resource-Priority: esnet.0"
],
"profileId": "Profile-5678",
"requestId": "45690",
"displayName": "James Smith"
}
}

Response samples

Content type

application/json

{"verificationResponse": {"requestId": "45690",
"displayName": "[V]John Smith",
"divResult": [{"div": {"tn": "12155551212",
"uri": null
},
"verstatValue": "TN-Validation-Passed"
}
],
"verstatValue": "TN-Validation-Passed",
"verstatPriority": "RPH-Validation-Passed",
"verifyResults": [{"verifyResult": {"ppt": "shaken",
"status": "pass",
"validClaims": {"attest": "B",
"dest": {"tn": ["12155551212"
],
"uri": null
},
"iat": 1664199282,
"orig": {"tn": "12155551211"
},
"origid": "123e4567-e89b-12d3-a456-426655440000"
}
}
},
{"verifyResult": {"ppt": "div",
"status": "pass",
"validClaims": {"dest": {"tn": ["12155551213"
],
"uri": null
},
"iat": 1664199282,
"orig": {"tn": "12155551211"
},
"div": {"tn": "121555551212",
"hi": null
}
}
}
},
{"verifyResult": {"ppt": "rph",
"status": "pass",
"validClaims": {"dest": {"tn": ["12155551212"
],
"uri": null
},
"iat": 1664199282,
"orig": {"tn": "12155551211"
},
"rph": {"auth": ["esnet.0"
]
}
}
}
}
]
}
}