Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 11:28amHello,
Is onespan allowing the sender to set a custom package ID?
- I want to add a custom package id when I am making POST api/packages, please find below request response
Request:
{ "method": "POST", "headers": { "Authorization": "Basic ", "Content-Type": "application/json", "accept": "application/json" }, "body": "{\"name\":\"Settlement Package\",\"roles\":[{\"id\":\"0000720276\",\"index\":1,\"type\":\"SIGNER\",\"signers\":[{\"firstName\":\"John\",\"lastName\":\"Smith\",\"email\":\[email protected]\,\"auth\":{\"scheme\":\"SMS\",\"challenges\":[{\"question\":\"+xxxxx\",\"maskInput\":true}]}}],\"name\":\"0000720276\",\"emailMessage\":{\"content\":\"This is a signer level email message for Insured1.\"}},{\"id\":\"Owner1\",\"index\":2,\"type\":\"SIGNER\",\"signers\":[{\"firstName\":\"FirstNameSigner2\",\"lastName\":\"LastNameSigner2\",\"email\":\[email protected]\,\"id\":\"Owner1\"}],\"name\":\"Owner1\",\"emailMessage\":{\"content\":\"This is a signer level email message for Owner1.\"}}],\"id\":\"a771fb55-a42c-48ca-a985-3a19b079d06d\"}", "timeout": 10000, "agent": { "_events": {}, "_eventsCount": 0, "timeout": null, "maxFreeSockets": 1, "maxSockets": 1, "maxTotalSockets": null, "sockets": {}, "freeSockets": {}, "requests": {}, "options": {}, "secureProxy": false, "proxy": { "protocol": "http:", "slashes": true, "auth": null, "host": "xxxx", "port": 4443, "hostname": "xxx", "hash": null, "search": null, "query": null, "href": "xxxx" } } }
Id is highlighted in bold.
Response:
{ "messageKey": "error.validation.packageDoesNotExist", "technical": "Could not retrieve the transaction summary for transaction uid: a771fb55-a42c-48ca-a985-3a19b079d06d", "message": "The specified package does not exist.", "code": 404, "name": "Resource Not Found" }
Reply to: Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 12:02pmHi Patel,
Thanks for your post! Unfortunately OneSpan Sign doesn't support custom package ID, all the transaction UID will be randomly generated by OSS system.
Duo
Reply to: Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 12:56pmSo in that case, in the above request, is id\":\"a771fb55-a42c-48ca-a985-3a19b079d06d considered as custom package ID or the User ID?
Reply to: Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 01:01pmHi Patel,
Please be aware that you shouldn't set "id" attribute directly under package level JSON, due to OSS doesn't accept custom package ID. I believe you would receive an error message saying "Could not retrieve the transaction summary for transaction uid: a771fb55-a42c-48ca-a985-3a19b079d06d" if you did so.
Duo
Reply to: Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 01:15pmThank you Duo. Can you just let me know, what is the point of having it if we cannot set it at the package level?
Reply to: Is Custom Package ID supported by OSS?
Thursday, March 3, 2022 at 01:48pmHi Patel,
From my own understanding, because POST call and GET call are using the same JSON Schema, it could make more sense if you pull the package JSON and reference to the generated package ID.
Duo