Changes
RP API version 3 changes compared to version 2
-
Requests
authentication
andsigning
have two counter-parts instead of one:dynamic link based
(newly added flows, relying on QR codes / Web2App links / App2App links) andnotification based
(the existing one from RPv2, relying on push notifications). -
Introduction of new signature protocols (
ACSP_V1
andRAW_DIGEST_SIGNATURE
). -
For authentication and signing requests, VC codes are returned from the server.
-
New VC codes formats.
RP API version 2 changes compared to version 1
-
Uses
v2
instead ofv1
in URL, for examplehttps://https://rp-api.smart-id.com/v2/
instead ofhttps://https://rp-api.smart-id.com/v1/
. -
New interactions concept allowed interactions order.
-
New parameter
allowedInteractionsOrder
added to authentication and signing requests. It replaces parametersdisplayText
andrequestProperties.vcChoice
. -
New parameter
interactionFlowUsed
added into session status response message. -
New session status end result codes:
-
REQUIRED_INTERACTION_NOT_SUPPORTED_BY_APP
-
USER_REFUSED_DISPLAYTEXTANDPIN
-
USER_REFUSED_VC_CHOICE
-
USER_REFUSED_CONFIRMATIONMESSAGE
-
USER_REFUSED_CONFIRMATIONMESSAGE_WITH_VC_CHOICE
-
USER_REFUSED_CERT_CHOICE
-
-
New parameter
requestProperties
for API/v2/certificatechoice
-
New option
shareMdClientIpAddress
for parameterrequestProperties
-
Previously deprecated object reference
pno/:country/:national-identity-number
removed, useetsi/:id-etsi-qcs-SemanticsId-Natural
instead. -
RP must ignore any unknown names (fields) in JSON response object.