VivoKey API Documentation

Good morning everyone,

Firstly, I apologies if I missed a post that includes the answer I’m seeking.
Second, I’m so excited to be a part of this community! I just got my first implant, Vivokey Spark 2!
On to the body…
I’m a developer, mainly Node JS and react, and I want to consume/ integrate with the Vivokey API. I’ve looked and looked for better documentation but nothing…
I’ve combed over the api docs and even attempted to grab request headers for a black attempt to post to I just can’t seem to get it working.
Has anyone else written a customer authorization method that I may be able to look at? Is there a list of scopes and response types? Is the “nonce” param in the request header a one off CSRF token?
Thank you in advance. I just really want to get it to this and see what I can use it for but I’m hitting 6 inch speed bumps in my low rider right at the start.

Hey mate, there is nothing worse than struggling right out of the gate, especially when enthusiasm and motivation is high.
You may get some answers here because there are more users, but the Vivokey forum will be a more targeted audience.
You can link your account on this forum to that one, here is the how to and even use your vivokey to authenticate.
Here is the link to the Vivokey Forum

Good luck and I look forward to seeing what you can do with your skills :keyboard: :+1:

1 Like

You’ll definitely want to get an OpenID Connect client package or library… it will make things was easier.

You’ll want to scan into the VivoKey app and create an “application” under the advanced section… this will create a client ID and secret for use with your OpenID Connect client configuration.

Also there is a post in the VivoKey members forum with a reference to node js library…

Hello good day, I am playing with the application of “VivoKey ChipScan Example” and the server is returning error 500; (

On the other hand, when I try to use the openid / token to obtain an acces token:


with a Custom Application registered in the VivoKey app, I get this error:

And with the data from the VivoKey app if the access_token returns without problem. I guess there is something I am missing, can you help me? : D

I installed a site in wordpress to test the authentication plugin, but following the steps I saw in its documentation and video, when scanning the QR with a session started in the app, it did nothing so I manually put the values ​​of the client id and the secret that I get when registering a Custom Application,

it registered and saved fine, however, when trying to use that authentication method I get:

Redirect URI Error

The request fails due to a missing, invalid, or mismatching redirection URI (redirect_uri).

and it makes sense because the endpoint:

bring the callback_url with null value

"success": true,
"apps": [{
"challenge_message": "Welcome welcome",
"client_id": "6058302150",
"callback_url": null,
"client_secret": "********************************************* ****** ",
"description": "Safe cardboard box",
"redirect_url": "",
"date_created": "2021-07-13",
"uid": "415ff16c00e01564ae0f038d9c72b1a5",
"name": "iOS Secure Box"
}, { ...

I’m still a novice at this, but I think there is a lot of potential, congratulations on all this you have achieved

:partying_face: :partying_face: :partying_face: :partying_face: :partying_face: :partying_face:

1 Like

jejejejejeje this must be:

And, with the data from the VivoKey app, the access_token returns a valid string without problem.

for the api error i’m sure @fraggersparks will respond when he’s awake :wink:

this typically has to do with the protocol… are you using https for your website and is the URL listed in the OIDC app in the VivoKey using https as well?

Thank you for answering me. Yes is an https site, but the URL is not in the OIDC. I will validate that, thank you very much

Hello @amal I already installed a minor version of WordPress and it works, I think there may be some compatibility detail. But hey, it works !!!

1 Like

hmm ok… do you happen to have any security plugins on your normal wordpress deployment that might be blocking things?

no, it was a fresh install just to test the plugin

and i just updated to the latest version and it still works

1 Like