Agent > SIOP

Initiate verification presentation from the wallet

get

Returns JWT token which describes details about the credential being verified. It is made by wallet app to get info about the credential.

Path parameters
correlationIdstring · uuidRequired

A UUID value that is bound to the VP

Example: f9dbff8e-6dba-4955-bd7f-61c083db290d
definitionIdstringRequired

The definitionId defines the credential to ask for, eg: emailCredential.The value should start with lowercase and continue using camelCase pattern.Must be one of the allowed definitions in the template endpoint.

Example: emailCredential
Responses
chevron-right
200Success
application/json
get
/api/v1/agent/siop/definitions/{definitionId}/auth-requests/{correlationId}

Finalize verification presentation from the wallet

post

Endpoint is used by mobile app and it shares the credential. In payload, there is expires_in which is the time the QR is valid. The state is the unique identifier for the request. vp_token is a JWT token that contains the verifiableCredential JWT token with all the details about the credential and in the header it includes the kid that is used to reference what wallet is working with this.

Path parameters
correlationIdstring · uuidRequired

A UUID value that is bound to the VP

Example: f9dbff8e-6dba-4955-bd7f-61c083db290d
definitionIdstringRequired

The definitionId defines the credential to ask for, eg: emailCredential.The value should start with lowercase and continue using camelCase pattern.Must be one of the allowed definitions in the template endpoint.

Example: emailCredential
Body
expires_innumberRequiredExample: 300
statestringRequiredExample: c35f4780-8570-4346-9252-6941747107b5
vp_tokenstringRequiredExample: eyJraWQiOiJkaWQ6YnN2OmVhM2Q1NDllMzM5NzE5MmQ5NDcyMzFiMTBiNWI5NzU4YjcxNzQ3NTFlNjQ4Njg4MjAxNzE0MDI4NTVhODYwMjkjc3ViamVjdC1rZXkiLCJhbGciOiJFUzI1NksiLCJ0eXAiOiJKV1QifQ.eyJpYXQiOjE3MzA3MTMzNDEsImV4cCI6MTczMDcxNDA2MSwidnAiOnsiaG9sZGVyIjoiZGlkOmJzdjplYTNkNTQ5ZTMzOTcxOTJkOTQ3MjMxYjEwYjViOTc1OGI3MTc0NzUxZTY0ODY4ODIwMTcxNDAyODU1YTg2MDI5IiwiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiXSwidHlwZSI6WyJWZXJpZmlhYmxlUHJlc2VudGF0aW9uIl0sInZlcmlmaWFibGVDcmVkZW50aWFsIjpbImV5SmhiR2NpT2lKRlV6STFOa3NpTENKMGVYQWlPaUpLVjFRaWZRLmV5SmxlSEFpT2pFM05qRTRNemMwTkRnc0luWmpJanA3SWtCamIyNTBaWGgwSWpwYkltaDBkSEJ6T2k4dmQzZDNMbmN6TG05eVp5OHlNREU0TDJOeVpXUmxiblJwWVd4ekwzWXhJbDBzSW5SNWNHVWlPbHNpVm1WeWFXWnBZV0pzWlVOeVpXUmxiblJwWVd3aUxDSkZiV0ZwYkVOeVpXUmxiblJwWVd3aVhTd2lZM0psWkdWdWRHbGhiRk4xWW1wbFkzUWlPbnNpWlcxaGFXd2lPaUowWlhOMFFHZHRZV2xzTG1OdmJTSXNJblI1Y0dVaU9pSkZiV0ZwYkNCRGNtVmtaVzUwYVdGc0lpd2lhV1FpT2lKa2FXUTZZbk4yT21WaE0yUTFORGxsTXpNNU56RTVNbVE1TkRjeU16RmlNVEJpTldJNU56VTRZamN4TnpRM05URmxOalE0TmpnNE1qQXhOekUwTURJNE5UVmhPRFl3TWpraWZTd2lZM0psWkdWdWRHbGhiRk4wWVhSMWN5STZleUpwWkNJNklqVTNZVEJrWWpWaU1XUm1aalEwWkRFeVpqQTFZakprTkRRd05XTmpPR05rWkdFME16RmhORGN5TmpCbFlqWmxOV0ZrWlRNMk16bGpOemN6TVRKak1tUWlMQ0owZVhCbElqb2lia05vWVdsdVNXUmxiblJwZEhsRGNtVmtaVzUwYVdGc1VtVjJiMk5oZEdsdmJsTjBZWFIxY3pJd01qUWlmWDBzSWtCamIyNTBaWGgwSWpwYkltaDBkSEJ6T2k4dmQzZDNMbmN6TG05eVp5OHlNREU0TDJOeVpXUmxiblJwWVd4ekwzWXhJbDBzSW5SNWNHVWlPbHNpVm1WeWFXWnBZV0pzWlVOeVpXUmxiblJwWVd3aUxDSkZiV0ZwYkVOeVpXUmxiblJwWVd3aVhTd2laWGh3YVhKaGRHbHZia1JoZEdVaU9pSXlNREkxTFRFd0xUTXdWREUxT2pFM09qSTRMalV4T1ZvaUxDSmpjbVZrWlc1MGFXRnNVM1ZpYW1WamRDSTZleUpsYldGcGJDSTZJblJsYzNSQVoyMWhhV3d1WTI5dElpd2lkSGx3WlNJNklrVnRZV2xzSUVOeVpXUmxiblJwWVd3aUxDSnBaQ0k2SW1ScFpEcGljM1k2WldFelpEVTBPV1V6TXprM01Ua3laRGswTnpJek1XSXhNR0kxWWprM05UaGlOekUzTkRjMU1XVTJORGcyT0RneU1ERTNNVFF3TWpnMU5XRTROakF5T1NKOUxDSnBaQ0k2SW5WeWJqcDFkV2xrT2pVM00yRXhNelUxTFRjNFpqSXROR1V3TWkxaU56WXdMVEF5WmpBeFpESmtZamM0T1NJc0ltTnlaV1JsYm5ScFlXeFRkR0YwZFhNaU9uc2lhV1FpT2lJMU4yRXdaR0kxWWpGa1ptWTBOR1F4TW1Zd05XSXlaRFEwTURWall6aGpaR1JoTkRNeFlUUTNNall3WldJMlpUVmhaR1V6TmpNNVl6YzNNekV5WXpKa0lpd2lkSGx3WlNJNkltNURhR0ZwYmtsa1pXNTBhWFI1UTNKbFpHVnVkR2xoYkZKbGRtOWpZWFJwYjI1VGRHRjBkWE15TURJMEluMHNJbWx6YzNWbGNpSTZJbVJwWkRwaWMzWTZaVEJrT1RaaU1HVmtORGcxWW1Gak9XVTFOV0kyWldabE9ETXpZV05oTXpJNU1EUTNOR1kxWkRjellUbGhPRGxsTURaaU0yVXlNVFV5TkRKbU9XRTNPU0lzSW1semMzVmhibU5sUkdGMFpTSTZJakl3TWpRdE1UQXRNekJVTVRRNk1UYzZNamd1TlRJd1dpSXNJbk4xWWlJNkltUnBaRHBpYzNZNlpXRXpaRFUwT1dVek16azNNVGt5WkRrME56SXpNV0l4TUdJMVlqazNOVGhpTnpFM05EYzFNV1UyTkRnMk9EZ3lNREUzTVRRd01qZzFOV0U0TmpBeU9TSXNJbXAwYVNJNkluVnlianAxZFdsa09qVTNNMkV4TXpVMUxUYzRaakl0TkdVd01pMWlOell3TFRBeVpqQXhaREprWWpjNE9TSXNJbTVpWmlJNk1UY3pNREk1TnpnME9Dd2lhWE56SWpvaVpHbGtPbUp6ZGpwbE1HUTVObUl3WldRME9EVmlZV001WlRVMVlqWmxabVU0TXpOaFkyRXpNamt3TkRjMFpqVmtOek5oT1dFNE9XVXdObUl6WlRJeE5USTBNbVk1WVRjNUluMC5uNFRaRjdsaTdyenVKbGxKay1CNXgza2hfRTM5WDVuUXFkc0NqSXRhRk5RV09SQ25oZnNyVTRYbkxubFdMcFBXbXhRUjlrLTY0VnFYZnhjV1ZmQy1VQSJdfSwiQGNvbnRleHQiOlsiaHR0cHM6Ly93d3cudzMub3JnLzIwMTgvY3JlZGVudGlhbHMvdjEiXSwidHlwZSI6WyJWZXJpZmlhYmxlUHJlc2VudGF0aW9uIl0sImhvbGRlciI6ImRpZDpic3Y6ZWEzZDU0OWUzMzk3MTkyZDk0NzIzMWIxMGI1Yjk3NThiNzE3NDc1MWU2NDg2ODgyMDE3MTQwMjg1NWE4NjAyOSIsInZlcmlmaWFibGVDcmVkZW50aWFsIjpbImV5SmhiR2NpT2lKRlV6STFOa3NpTENKMGVYQWlPaUpLVjFRaWZRLmV5SmxlSEFpT2pFM05qRTRNemMwTkRnc0luWmpJanA3SWtCamIyNTBaWGgwSWpwYkltaDBkSEJ6T2k4dmQzZDNMbmN6TG05eVp5OHlNREU0TDJOeVpXUmxiblJwWVd4ekwzWXhJbDBzSW5SNWNHVWlPbHNpVm1WeWFXWnBZV0pzWlVOeVpXUmxiblJwWVd3aUxDSkZiV0ZwYkVOeVpXUmxiblJwWVd3aVhTd2lZM0psWkdWdWRHbGhiRk4xWW1wbFkzUWlPbnNpWlcxaGFXd2lPaUowWlhOMFFHZHRZV2xzTG1OdmJTSXNJblI1Y0dVaU9pSkZiV0ZwYkNCRGNtVmtaVzUwYVdGc0lpd2lhV1FpT2lKa2FXUTZZbk4yT21WaE0yUTFORGxsTXpNNU56RTVNbVE1TkRjeU16RmlNVEJpTldJNU56VTRZamN4TnpRM05URmxOalE0TmpnNE1qQXhOekUwTURJNE5UVmhPRFl3TWpraWZTd2lZM0psWkdWdWRHbGhiRk4wWVhSMWN5STZleUpwWkNJNklqVTNZVEJrWWpWaU1XUm1aalEwWkRFeVpqQTFZakprTkRRd05XTmpPR05rWkdFME16RmhORGN5TmpCbFlqWmxOV0ZrWlRNMk16bGpOemN6TVRKak1tUWlMQ0owZVhCbElqb2lia05vWVdsdVNXUmxiblJwZEhsRGNtVmtaVzUwYVdGc1VtVjJiMk5oZEdsdmJsTjBZWFIxY3pJd01qUWlmWDBzSWtCamIyNTBaWGgwSWpwYkltaDBkSEJ6T2k4dmQzZDNMbmN6TG05eVp5OHlNREU0TDJOeVpXUmxiblJwWVd4ekwzWXhJbDBzSW5SNWNHVWlPbHNpVm1WeWFXWnBZV0pzWlVOeVpXUmxiblJwWVd3aUxDSkZiV0ZwYkVOeVpXUmxiblJwWVd3aVhTd2laWGh3YVhKaGRHbHZia1JoZEdVaU9pSXlNREkxTFRFd0xUTXdWREUxT2pFM09qSTRMalV4T1ZvaUxDSmpjbVZrWlc1MGFXRnNVM1ZpYW1WamRDSTZleUpsYldGcGJDSTZJblJsYzNSQVoyMWhhV3d1WTI5dElpd2lkSGx3WlNJNklrVnRZV2xzSUVOeVpXUmxiblJwWVd3aUxDSnBaQ0k2SW1ScFpEcGljM1k2WldFelpEVTBPV1V6TXprM01Ua3laRGswTnpJek1XSXhNR0kxWWprM05UaGlOekUzTkRjMU1XVTJORGcyT0RneU1ERTNNVFF3TWpnMU5XRTROakF5T1NKOUxDSnBaQ0k2SW5WeWJqcDFkV2xrT2pVM00yRXhNelUxTFRjNFpqSXROR1V3TWkxaU56WXdMVEF5WmpBeFpESmtZamM0T1NJc0ltTnlaV1JsYm5ScFlXeFRkR0YwZFhNaU9uc2lhV1FpT2lJMU4yRXdaR0kxWWpGa1ptWTBOR1F4TW1Zd05XSXlaRFEwTURWall6aGpaR1JoTkRNeFlUUTNNall3WldJMlpUVmhaR1V6TmpNNVl6YzNNekV5WXpKa0lpd2lkSGx3WlNJNkltNURhR0ZwYmtsa1pXNTBhWFI1UTNKbFpHVnVkR2xoYkZKbGRtOWpZWFJwYjI1VGRHRjBkWE15TURJMEluMHNJbWx6YzNWbGNpSTZJbVJwWkRwaWMzWTZaVEJrT1RaaU1HVmtORGcxWW1Gak9XVTFOV0kyWldabE9ETXpZV05oTXpJNU1EUTNOR1kxWkRjellUbGhPRGxsTURaaU0yVXlNVFV5TkRKbU9XRTNPU0lzSW1semMzVmhibU5sUkdGMFpTSTZJakl3TWpRdE1UQXRNekJVTVRRNk1UYzZNamd1TlRJd1dpSXNJbk4xWWlJNkltUnBaRHBpYzNZNlpXRXpaRFUwT1dVek16azNNVGt5WkRrME56SXpNV0l4TUdJMVlqazNOVGhpTnpFM05EYzFNV1UyTkRnMk9EZ3lNREUzTVRRd01qZzFOV0U0TmpBeU9TSXNJbXAwYVNJNkluVnlianAxZFdsa09qVTNNMkV4TXpVMUxUYzRaakl0TkdVd01pMWlOell3TFRBeVpqQXhaREprWWpjNE9TSXNJbTVpWmlJNk1UY3pNREk1TnpnME9Dd2lhWE56SWpvaVpHbGtPbUp6ZGpwbE1HUTVObUl3WldRME9EVmlZV001WlRVMVlqWmxabVU0TXpOaFkyRXpNamt3TkRjMFpqVmtOek5oT1dFNE9XVXdObUl6WlRJeE5USTBNbVk1WVRjNUluMC5uNFRaRjdsaTdyenVKbGxKay1CNXgza2hfRTM5WDVuUXFkc0NqSXRhRk5RV09SQ25oZnNyVTRYbkxubFdMcFBXbXhRUjlrLTY0VnFYZnhjV1ZmQy1VQSJdLCJhdWQiOiJkaWQ6YnN2OjVhYzljZWZiYWE5MDFhY2M1NGViOTM2MzY5YzczNmVlNmM4YmNiYmFjZTY4NzgzNmY1NjM5Yzg0MGE4MGIwNmEiLCJuYmYiOjE3MzA3MTMzNDEsInN1YiI6ImRpZDpic3Y6ZWEzZDU0OWUzMzk3MTkyZDk0NzIzMWIxMGI1Yjk3NThiNzE3NDc1MWU2NDg2ODgyMDE3MTQwMjg1NWE4NjAyOSIsImlzc3VhbmNlRGF0ZSI6IjIwMjQtMTEtMDRUMDk6NDQ6MjEuMzMyWiIsImlzcyI6ImRpZDpic3Y6ZWEzZDU0OWUzMzk3MTkyZDk0NzIzMWIxMGI1Yjk3NThiNzE3NDc1MWU2NDg2ODgyMDE3MTQwMjg1NWE4NjAyOSIsIm5vbmNlIjoiODdmOWE3ZDgtNWM4YS00MTI5LTk3NzYtMjQxNTkzMWEyMDVlIn0.Vb7kUmM51_BWU_b27Q9ihP2_XUTXvpBRmH79qhz4iGxxKMr2aNjk1i8UpSkTcsStyxNnoA9m6dakReV8B9bN1Q
presentation_submissionstringRequiredExample: "{"id":"5uoUCy1rucwT0Ri8X1JEe","definition_id":"emailCredential","descriptor_map":[{"id":"c77537b3-4f81-4cda-af11-7f7118645c1f","format":"jwt_vp","path":"$","path_nested":{"id":"c77537b3-4f81-4cda-af11-7f7118645c1f","format":"jwt_vc","path":"$.vp.verifiableCredential[0]"}}]}"
Responses
chevron-right
200Success

No content

post
/api/v1/agent/siop/definitions/{definitionId}/auth-responses/{correlationId}

No content

Last updated