Alloy Hosted SDK

Use the Alloy Hosted SDK to seamlessly implement step-up verification without the need to integrate.

A unique short link and QR code are automatically generated for each entity when a Journey enters step-up node. You can either retrieve this link and QR code through the Journey application via the Alloy dashboard or retrieve this link and a base 64 encoded QR code directly via API. The link & QR will be valid for 48 hours.

Retrieving the Short Link and QR Code via API

Upon reaching the step-up node in the Journey Application or upon listening to the pending_step_up webhook, make a POST call to the https://api.alloy.co/sdk/url endpoint and include the sdk_key, entity_token, journey_application_token, and journey_token in the request body:
```
{
    "sdk_key": "c376b24d-033e-4169-9dde-0ecbec1accac",
    "entity_token": "P-WhLUMGUqeIjEwz5drwQo",
    "journey_application_token": "JA-PMQihWV16ILFsbub7Mko",
    "journey_token": "J-XLSYxOv2I1koXuYquI6E"
}
```

The short link and a base 64 encoded QR code will be returned in the response:

{
    "link": "https://docv.alloy.co/OtS8F",
    "qr_code": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53Ay5vcmcvMjAwMD9zdmciIHZpZXdCb3g09IjAgMCAzMSAzMSI+PHBhdGggZD0iTTEgMWg3djdoLTd6TTEyIDFoMXYxaC0xek0xNCAxaDN2MWgxdi0xaDJ2MWgtMXYxaC0ydjJoMXYxaC0ydi0xaC0xdi0xaDF2LTFoLTF2MWgtMXYtMWgtMXYtMWgxek0yMSAxaDF2M2gtMXYyaC0xdi0zaDF6TTIzIDFoN3Y3aC03ek0yIDJ2NWg1di01ek0yNCAydjVoNXYtNXpNMyAzaDN2M2gtM3pNOSAzaDF2MWgxdjFoLTF2M2gxdi0zaDF2LTFoMXYzaC0xdjFoMXYtMWgxdjNoM3YxaDN2MWgtM3YyaDF2MWgtMnYtMWgtMXYtMWgxdi0xaC0xdjFoLTF2LTFoLTF2LTFoLTF2LTFoMXYtMWgtMXYxaC0xdi0xaC0yek0xMSAzaDF2MWgtMXpNMjUgM2gzdjNoLTN6TTE4IDRoMXYxaC0xek0xOCA2aDJ2MmgtMXYtMWgtMXpNMjEgNmgxdjNoLTF2MWgydi0xaDV2MWgtMnYxaC0xdi0xaC0xdjJoM3YxaDF2MWgtMnYtMWgtMXYxaDF2MWgtMXYxaC0xdi0xaC0xdjFoLTF2LTFoLTJ2LTFoNHYtMWgtMnYtMWgxdi0xaC0xdjFoLTF2LTFoLTF2LTNoMXpNMTUgN2gxdjJoLTF6TTE3IDdoMXYzaC0xek0xIDloMXYxaC0xek0zIDloNXYxaC0xdjFoMXYtMWgydjFoMnYyaC0xdi0xaC00djFoLTF2MWgtMXYtMWgtMXYtMWgydi0yaC0xdjFoLTF2LTFoLTF6TTIgMTBoMXYxaC0xek0yOSAxMGgxdjFoLTF6TTMgMTFoMXYxaC0xek0yMCAxMmgxdjFoLTF6TTI4IDEyaDF2MWgtMXpNMSAxM2gydjFoLTF2MWgxdjFoLTF2MWgtMXpNNyAxM2gxdjFoLTF6TTkgMTNoMXYyaC0xdjFoMXYyaC0xdjFoLTF2LTFoLTJ2LTFoMnYtMWgtMXYtMWgxdi0xaDF6TTE4IDEzaDJ2MWgtMnpNNiAxNGgxdjFoLTF6TTExIDE0aDN2MmgtMXYxaDF2MWgzdjFoMXYxaC0xdjJoM3YtMWgydi0xaDF2MWgxdi0xaC0xdi0xaC0xdi0xaDR2MWgtMXYyaDF2MWgxdi0xaDF2LTFoMXYxaDF2MmgtMnYxaC0ydjJoLTR2MWg0di0xaDF2LTFoMXYyaDF2MmgtMXYtMWgtMXYxaC0xdjFoLTJ2LTFoMXYtMWgtMXYxaC0xdi0xaC0xdjFoLTF2LTFoLTF2LTFoLTF2MWgxdjFoLTJ2LTFoLTF2MmgtMXYtMWgtMXYxaC0xdi0xaC0xdjFoLTF2LTJoLTF2MWgtMXYtMWgtMXYtNGgxdjJoMnYxaDF2LTFoNHYxaDF2LTFoMXYtMmgxdi0xaC0xdjFoLTF2LTFoLTJ2LTFoLTF2LTFoMXYtMWgtMXYxaC0ydi0zaC0ydi0xaDF2LTJoLTF6TTI5IDE0aDF2MWgtMXpNMTAgMTVoMXYxaC0xek0xOCAxNWgydjFoMnYxaC0xdjJoLTF2LTJoLTF2LTFoLTF6TTI2IDE1aDJ2MWgtMnpNNCAxNmgydjFoLTJ6TTE1IDE2aDF2MWgtMXpNMTcgMTZoMXYyaC0xek0yNSAxNmgxdjFoLTF6TTI4IDE2aDF2MWgtMXpNMjYgMTdoMnYzaC0xdi0yaC0xek0xIDE4aDV2MWgtMXYyaC0xdi0yaC0ydjNoLTF6TTEwIDE4aDF2MWgtMXpNMjkgMThoMXYxaC0xek03IDE5aDF2MWgtMXpNMTEgMTloMXYyaDF2MWgxdjFoLTF2M2gtMXYtMWgtMXYtMWgtMXYtMWgydi0xaC0ydi0yaDF6TTE5IDE5aDF2MmgtMXpNMjEgMTloMXYxaC0xek02IDIwaDF2MWgtMXpNOCAyMGgxdjFoLTF6TTMgMjFoMXYxaC0xek01IDIxaDF2MWgtMXpNNyAyMWgxdjFoLTF6TTkgMjJoMXYxaC0xek0yMiAyMnYzaDN2LTN6TTEgMjNoN3Y3aC03ek0yMyAyM2gxdjFoLTF6TTIgMjR2NWg1di01ek0xNSAyNGgxdjFoLTF6TTE3IDI0aDF2MmgtMXpNMjggMjRoMXYxaC0xek0zIDI1aDN2M2gtM3pNMjAgMjV2MWgxdi0xek0yOSAyNWgxdjFoLTF6TTkgMjloMXYxaC0xek0yMCAyOWgxdjFoLTF6TTIyIDI5aDF2MWgtMXpNMjcgMjloMXYxaC0xeiIvPjwvc3ZnPg=="
}

The encoded QR code can be decoded to unveil an svg image

Expired Short Link

The generated link will expire after 2 days from creation, by default. Expiration time can be managed in the dashboard under Settings > SDK and scrolling to Hosted SDK Expiration.

The expiration time is in whole days.

Creating a New Short Link and QR Code

Make a POST call to the https://api.alloy.co/sdk/url endpoint as described above. This will create a new link and QR code that can be sent to users. The journey application must still be in a pending step-up state for the SDK to render properly.