Day of Exam Process
Check-In Workflow
The workflow below outlines the user experience from the moment they walk in the door to point where they start the exam in the InteRoads system.
Test Provisioning Endpoint
In the above flow, the test provisioning endpoint will be sent after the user has completed the check-in process at the remote testing center.
Parameters
| Attribute | Datatype | Notes |
|---|---|---|
| firstName | string | The first name of the user |
| lastName | string | The last name of the user |
| string | The email address of the user | |
| phone | string | The contact phone number provided by the user. |
| birthdate | string | The user's birthdate. |
| amountPaid | numeric | This might not be used by Interoads, but we will send it in the event you wish to store the value. |
| examId | string | The examId in the InteRoads system that the user has registered for and needs to take. |
| sessionSid | string | The ID that is stored in our system that uniquely identifies this appointment. We will need this sent back to us in the exam completion webhook. |
| locationSid | string | The id of the location within the SmarterProctoring system. |
| accessCode | string | The 9 character access code that is in the format of xxxxxxxxx. This will be the code that, ideally, will be entered when the user sits down at the computer to begin their exam. |
| photo | base64 | A base64 representation of the photo that was taken during the check-in process. |
| documents | array | An array of objects indicating the document(s) that were provided as proof of ID. |
Sample JSON Payload
{
"firstName":"JASON",
"lastName:" : "FILL",
"email":"jasonfill@email.com",
"phone" :"111-222-3333",
"birthdate" :"1900-01-01",
"amountPaid" : 29.99,
"examId": "12345678",
"sessionSid" : "ESb3fa751d9d7a4a909818116f1977664b",
"locationSid" : "PL909818116f1977664bb3fa751d9d7a4a",
"accessCode":"123456789",
"photo" : "data:image/jpeg;base64,/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAAA8AAD/4QMraHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA1LjMtYzAxMSA2Ni4xNDU2NjEsIDIwMTIvMDIvMDYtMTQ6NTY6MjcgICAgICAgICI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bXA6Q3JlYXRvclRvb2w9IkFkb2JlIFBob3Rvc2hvcCBDUzYgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOkRBRDI0NUI5OUQ2RjExRTRBOTQ0QkZFNkJFRTYwRjgzIiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOkRBRDI0NUJBOUQ2RjExRTRBOTQ0QkZFNkJFRTYwRjgzIj4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6REFEMjQ1Qjc5RDZGMTFFNEE5NDRCRkU2QkVFNjBGODMiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6REFEMjQ1Qjg5RDZGMTFFNEE5NDRCRkU2QkVFNjBGODMiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz7/7gAOQWRvYmUAZMAAAAAB/9sAhAAGBAQEBQQGBQUGCQYFBgkLCAYGCAsMCgoLCgoMEAwMDAwMDBAMDg8QDw4MExMUFBMTHBsbGxwfHx8fHx8fHx8fAQcHBw0MDRgQEBgaFREVGh8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx8fHx//wAARCAA9AOsDAREAAhEBAxEB/8QAtgAAAgMAAwEAAAAAAAAAAAAAAAYEBQcBAgMIAQACAwEBAQAAAAAAAAAAAAAABAIDBQEGBxAAAQIFAgMDBgoGBgsAAAAAAQIDABEEBQYhEjETB0FRImFxgTIUFZGhQlKyc7N0NwixYoIjFjbB0XIkNXWSosLS4jM0tBcYOBEAAQMCAwUECAMIAwAAAAAAAQACAxEEIRIFMUFRMhNxgSIUYZGhsdFCcjQjMwbB4VJigiQVNfCSQ//aAAwDAQACEQMRAD8A+mb1e7TZbe5cbrVN0dE0QFvumSQVGQ+MxxxA2qcUTpDlaKlSKGtpK6kZrKR1L1NUIS4y8jVKkKEwR5xADVcewtJacCFIjqiiBCIEIgQiBCIEIgQiBCj1lU3SUj9U7PlU6FuuS47UAqMvgiTW5iBvKi5waCdwSfb+r+H1TobcW/Rz4OVDYCdfKhS5Q+/Spm7q9iQj1OJ2+ib6Guo65hNRRvIqGFeq42QpJ9IhB7HNNCn2PDhUKSOERUkQIRAhECEQIRAhECEQIRAhECEQIXVR4zgXK02qnxvKrbkLNQ9QpcCaZ0sOc0BM1DWaZE6GL57d0VM29UwXDZa03K6HCKFeiBCIEIgQs0/MP+F1w+tY+0EL3PKtjQvuR3pl6a/yDj/3Bj6AiyLlHYkr/wC4f9R96ZosSiIEIgQl/LM2x7FWqV29PqZRWvez05QhSyVnXXaNAO+IPkDRimba0kmJyDlFSmAcBE0siBCIEIgQqvJv5duv3R/7Mxbb/mN7f2qqfkd2JP6ZWSz3LCGk11GzUBTroKloBVLd87iPhjQ1KZ7JzlJ2LP0+Fr4BmA2quvFqr+ntxTerKpbtgfWlNfQKVMImZAgn4ldnA6RbDK26aWPH4gGBVUsbrVwezFh2habQ1tPW0bFXTK3sVCEuNq4TSoTE4x3tLSQdoWwxwcARsKkRFSRAhECEQIRAhECEQIRAhECEQIXRfqq9MAXCs76Lf4Zdvvp+iI1tX5m/SsrSuV31LR4yVrJNzb323dbCmgvVVbmbnXCgqWWG6Nadns1Q/wAxJqKd9QXuZSn1tsvkz1iqStRinbTIWPzMDi1tfm/iaNzqb0i2vP8AM3btSW2oryvmXxe98ssAqt3tyqBpjRAGrjLh3jxaRS2R1aHitSWxhDC6nycTzZc1faPQtqn5OyHF53FZt+Yf8Lrj9ax9oIWueVbOhfcjvTL01/kHH/uDH0BFkXKOxJX/ANw/6j70zRYlF5+0Mb9nMRvnLbMT+CBdoV6DhAuLFfzMz93Yz/mX+yIVut3avQ/p/mf9K2ocIaXnkQIXVa0IE1EAd5Mv0wIGK4Q4hYmhQUO8EGBFFXZN/Ll1+6P/AGZi23/Mb2/tVU/I7sS70h/kpj6536UOar+cexJ6X+SO1XGctsrxC7h6WwUzhBPeBMf6wEL2ZPVb2pi7A6TuxV3Stby8IoC7OaeYEz+aHFbYt1MDrlU6dXohN05DWEU+hKkngQfNAhcwIRAheNTVU1M2XKh1DTY4rcUEpHpVHQ0nYKqLnAbTRQGMoxt53lM3SlccJkEJeQST5NYtNtIBUtPqVYuIzhmHrVkVoDe8qARKZUSJS75xTiVbUBcNOtPNpcaWFoVqlaTMH4IF1DjjbTZW4pLaE6lSiAAPKTBTHBcJG9VgyrGS6GvetIXfmc5uf6Yu8tJSuU+pU+YjrTMPWrIOIcZ3oUFoUmaVJMwRLsIimmKtOxZ90X/wy7ffT9ERravzN+lZelcrvqTtX36y29wN11cxTOK9VDriUKPoJjNZC948LSVovmYzaQFJYepaplD7K0PNHxNOIIUnzpIistIwKsa6uK7ezsAz5aZznOQnMGc/h1gopVK9JD4pQLlVmv5h/wALrj9ax9oIXueVbGhfcjvXlVvv0/5fA9TuLZebsiChxtRSoHlgaESMFaRdyA0G/oRXxrMcFqupfUK0UONW24PWuw2tst3W771qdeWtZc28zRZICgEoChIak8IXjLnigNAtm9ZbWjnSOaHPdsHBPo/LRiXIn70uXt/EVvNQDu79oT/TF/lRxKzD+oJieVuXgqm3ZHmXSzJ6SwZVWqu2KXJXLt92c3FbJJl4idfDPxJnw1SeyIhzmOodivkghvYi+IZJW7RxUj8zqA7ZccbCykOV5SFpOo3IAmk9+ukF3sA9Kj+nTR7zTY3Ypv8A6+vaH+NLwfJzD/vRLy+O0qn/ADYoR02K06ldS6jFW6LGrCyq65bXIQ3StK/eFAI2h1wD1lqPAek6RKWTLRo2qmw08TkyyeGIGv7lSW/obfb8gXDPskrKuuekpdFSubWW567ZmadP1UgRWLcnmKZfrLIsIGNA48VX5V0fRhVrfyLG8tqrMujHM2Vbk2lkcETTt1UewoV5o4+HIKgq221XzDhHJGHV4Jh6eZ7kGYdO7tU3m3rZdp6Z5tFwSnY1VSaVMoToQpJ9aWndDdhIXPbUbx71la9Zx25cGO2g4bxgmDpItDWDsrWoIQHXiVEgADd3xpaoPxjTgvPaYQIR2qqzHIHcqqk4pjZD4dUDca5My0hCTOUxxE+JHmi60gEI6sncqbqczERR9656g9Q7N0xxqjt1KgVV0U1y6CkJkJJEi86RwTu+E6ebFu7nxFx2len0fSTNRowY3aV8z5H1IzfIahTtzu1QUEmVO0tTTCQTwDaClPw6xmOlcdpXuLewhiFGtCrrVkuS2+qbcttyqqd+Y2cp1YJM5AbQSDM94iIe4HBWyW8TgczW0X1T00zLJfd9vt+dOMsXu4eK3MGSKlbI0DlQ2JBG5Ukp0me2NGKQ/NtXiNQtI8zjBXK3bw7k35bk1Ljtmcr3gFuEhFMzORccPAf1w/a25lfl9awbm4Ebc3qSZZcHuuU7L1l1S6UPSXS25BKEpQeBI+SCOwCffGjNeMg8EIGG0rOitHTeOU9yYX+leEvMctNBylS0dQ45uHlmVGFG6lMDtqmzp0JGyiTMipshwqkqaAvOXLGbi05TtFwneytSSBrrt/QY0YDHcEO5ZB7VnziS3BHNGfYmTp/daS09NGbhVq2MU4eWrsJ/eqkkec8IUvoy+5yjfRN2UgZbZjuqqe2We+9QHjdL2+5RWAKPslvZJTvAPH/iPoi6SVlqMrBWTeVSyN90czz+HuCaP/FmEcjle75GUuZzHN49O6UJ/wCRmrWqb/x8NKUSzdLLfsAdF0sjzlZYAqVZb3VT5aSZbvMJ+t8MOxyx3QyPFH8UnJE+1q5hqzgvbo+64cevb1OmbpfUtpB1M+WCkGI6qBnYHcFLTHHI8jiq7pxj2O5G1X1l7/v15U6rnsurUFITpJQAM9T8EWahPJEQGYMVdjbslBL8Xp6xPEG8bdrm6aoW5QVK0rp6ZevKkCFAEntjNubozUqMQtG3thFWhwKZRwEKBNogQs0/MP8AhdcfrWPtBC9zyrY0L7kd6j3H/wCd1f5I39AQH8ruXWf7D+tTegNFT03S20qaTtXUl954j5Sy8pM/9FAEdtxRihrby66dXdRaMOEXrJWWfmQpad7plUvOJBcpaqncYV2pUpzlql+ysiF7nkK2tAdS5A4gpL6wVDlT056evOnc44unK1HiTyEzMVTcrVoaW3LPP3+8r6F7AfJDq8qViPSdhF+6sZrklcA5VUL5pKPdry0KUpsS8zbIT6TCsIzSE8F6LU3dO1ijGw4n3rWsjyOz45aX7rdqhNPRsCalKOqieCEjtUewQw5wAqVhW9u6V4YwVKxi1WfI+sl8bvl+Q5bsFo3D7ut0ylVQR2kjjP5S/wBlPfCoaZTX5V6GSWPT48kfimO08FsV4o6SixGvpKRpDFKzROoaZQAlCUhpQAAGkaFsKSN7QvK3by5r3HaQVh2J01sqapijyCoq6W3VX/SLQrawVhUlBU9Br2/0R6m6c4AujAzD1rzFs1rnBrycp9S3iyWG0WWj9nttOhhriojVSz3qUdTHl5p3yGrivSwwNjFGhfHXU+81+S9QrxUJSt/ZUqpqVtCSspaYUUJCQkHumYxZnFzivpWmxNigaMMRVT8U6G9Q8hWhXu822jWQVVVd+6AT3hsjmK8nhl5Y6y3c70Kq51iCMbcx4BaCqzYJ0rYeVSBGQ5lTIDr9U9t5FAkkJ5q0zkk+LwImXFdkhF1GxelyyTNNenHwQn1u+PuXhXMXi2YZes9yB5019elymxxNQhLVXOsAbVVObfVVygeUgeogacYMQ3O7apsLHzNgj2NNXcMN3x4lMhu7mUN9PVVx3NVbDa6kHXe6lYQ5P+0W/jj0WmOpbPfvovEa7CG3gjGzMtsHAS4RlptECEv55RsVeJXRp4ApSwpxJPYpsbkn4oZs3lsre1LXbA6MrLLg+4npPY6YGTdTWrS6e9IW4Y3Y2/3jzvA+CxHO/tGDcXfFbXQUzNLQ09MyAGmW0IQBwklIAjzb3VJPFeiY2gA4KREVJeFbTM1VK9TPJCmnkKbcSfmqEjHWuLSCFF7QQQeCz7oqgItV1bTqlFYUjuICAI1dXNXtP8qzNKFGuH8ymZP03NRXKvOPVJtt3mVq2khtxXGcxqknt7DELbUMoySDM33KVzY1OeM0co+M5/dKe7px7LGPZrgohDFXIJQ4TomctPF2FOkSuLFpZ1IjVvDguQXrg7JKPEtEHARlLURAhZp+Yf8AC64/WsfaCF7nlWxoX3I71HuP/wA7q/yRv6AgP5Xcus/2H9atehX4UWH+w9/3Dkdt+QKrWfun/wDNyfovWWsy/MX+Fdx+vpvtkwvc8hWxoX3I7D7kkdVaOoV0bwu5toLjNu9kXUAdiVshIPmmJemK5uRpWlpzh5yVu92ZbrZrvQ3i00t0oXA7SVbaXWlgz0UJy07RwMNg4LzM0RY4tO0FYc7eEdKert5qLo24MbyRC6pl5tO4h2e/aB2kLKkeZQhOvTeSd69H0vO2jQ0/iR4U9C97Dj2QdXL21k+VIXR4fSrnaLPMjnj56vIflL4ngnTWJNaZTU7FGeeOxYYosZTzHgtzYZp6anbYYQllhlAQ20gBKUpSJAADQACGwF5suJPpKT1ZzYcho8qt1rcL6rPTrRUVCf8AlKU40uYQoHXbtkYlbPBkAHEe9Tv7N8UGZ/ztKpsJxi3ZF04ao6xPiDryqd8eu2ueiky+MRr3tw+G4JHDFYlpbtlt6Hjgu+LZLcsbuYxTKF7W9Bbbir1FInJKSo/J7ieB0MRurdkzerF3hdtrh0TulJ3Hima+ZDhGItKfr36W3LcmpLTaUh90n5jaBvWSe4Riuc1q9BDbzT8tSPYslyvrbfbzUotWO0z9Ay+8qmUw0Aq8uyTPwMEKTTIOg3r8WswNIVfOXYBbtrpDIxnkIJH/AE7zvPoV3066K+ymlvWZJafrqYFdJbk7VNtKJ3c2pc4vvz1KiZA8InFBTF21K32rVBZEcDv2V9A4LMevvUZrKcgatFrc5totSlJQtGoeqT4VLTLilPqp9MUXEmZ1AtrRLDoxlzh43e7gtRfwu7W3pri9XSJV72sLKH3W0jxScIdXp28tXZ5439JlDR03bHD2rwX6iBlmdKza13sWjYrlduyK2oqaVYDoAFTTz8Ta5agju7jFN1bOhdQjBRtrlsrag4q8HCF0wFnPVXLmm7e9YLeS/cKkf3lLfi5TSfErdLtMvgnGtptqS7qOwasrUbkBuRuLlW2vHXb70hp6anE6thbr9Kk8StDq5p/aSTF0tx0rwk7MFTFB1LUAcwqmjp9mFPerY1SPqDV3o08qqp16LJR4d4Ho17jCN9aGN2YchxTtlch7aHnCcBwhFPJRz/MaayW5ymYVzbvVDl0tMjVYK5jeQPi7zDtlZukdU4NG9I3102NlPmKUul16pbHi1zrbhuS0mubbcKRqkrSlMyCdBMxoalCZZWtZ/CUlp8wjjcXfxLWWnEONIcbUFoWkKQpOoIImCIwqEbVtAgioWbdZPZHUWmna1u6qkezBHr7DoeHZvlGvpQd4z8tFlamW+EfNVaSyFhpAWZrCRuI75axkuIrgtVtaYrtHF1KPVLEa7LMOq7LQvNsVLy21oW9PZ+7WFSO0HuiuVpcKBPaddCCUPIrTgvKrwyud6WnEUvt+2+7k0YqDPllaUAT+dKYjnTOTKutum+Z6tPDmqpfTjGavF8LttjrHW3qmjSsOONT2ErcU5pu10Co7GzK0BV31y2aYvG9NA4RYlEn9VMPrsuw2rsdC82xUvracbcens/drCyDtB7oqlaXNoE/pt2IJg8itKqwtmLUyMNpMauqG62nbo26OrTI7HNqAlUp68RMRIM8OUqiS4PWMjMMarNWuk/UnEqh5GA5EhNpeWVptlwmQ3M9h2uD0gAmKBC5p8JwWwdTt5wOuwl9NoWjZLhtryvHkWvImUvL2JJea8Cm39si40TqnX4ovczM2hWTBdPhkzRmnwWb0WA9a8OHsmKXumutnToxSV4kptPYBunw/VWB5IX6UjeU4LYde2VxjKwtdxC61uF9esrQaLIL3S2a1LkmoaofXWntHg118rnogMcjtpwQy7sYPFG1z3+lP+L9NcfxnGamx2pKkGsaUiqrVyLri1pKd6uA0nomGbdojIIGxYuoXb7okvwqrTEccTj1lbtqXi/sWtZcI2z3mcpQ1dT9V+ZZ9tB0mZVxlOLW3I7cujrEyWJlioAmttXen+qOW1y6F2YbOCLi3bKKHakzIejCL3aqGnqLspu6UTiAm7oYR7R7K2ZpYSuYUkpVqlYMx5opvcsz8wGVaWk3slozKT1G8CmHGsKwvBbe/UUjaKbakrrrrUqCnlicypx1XAT7BIRU1jWBSnu5bl4B7gsU6rdbbhkq3caw1Dyre5NuorWUKL1TPQobSnxJbPDhNX6VZpy7Bq9HpukNhHUm5uG4fvUzo30GuCa9jIcrp+QzTkO0Nrc9dax6q3k/JSOxJ17/KQW+8qGra00tMcWJ3n4L6LMiJdnAiHh6F5MiqSbz0woX643KyVbtmuBJJWyTy1EmZ0BBHwxow6iWjK8B7VnTaeHHM0lrlEOE9QH08irytXsx0VykELI7pjafjiwXkAxEeKh5Sc4GTBWlu6cWW32qtpadSzWVzK2Xrg743fGCDKfDjC8t+97gTsB2K+OxY1pA2nerbFLAmwWNi1h4v8jceaU7Zlairh6YpubjqvLlbbQdJmVVWS9O7TeKr3hTuOW26g7hWU+hKh2qE0zPlmIvt798YynxN4FU3Fix5zDwu4hVX8F9RCOScrPs/Aq2q5kvPx+OL/OW+3p4qnyk+zqYK2xzp3abPUe3vOOXC6nU1tQSSCeO0TML3F++QUGDeCugsWMNTi7iuLD09t9vs9wtVY57dS3B4uuBadstBKXlEuME16XODmimVdhsw1pa7HMqlHT3K7aCxYckcYoZ+Bh4bigHuPiHxCGfPxPxkZV3FL+RkZhG+jVZY307prbcDd7nVLu13Pq1D05IMvkpJOvdOKLi+L25GjI1XQWIY7M7xO4pyHAQgn0QIRAhECEQIRAhECEQIRAhECEQIRAhECEQIRAhECFCu/ur2B73tyPd8j7R7Vs5O39fmeH4Y46m9TjzZvDXN6FV4v/AvLX/C3uzlTPM92ciU/wBbkxFuXcrbjrf+mbvTCOETS6IEIgQiBCIEIgQiBCIEIgQiBCIEIgQiBCIEL//Z",
"documents":[
{
"code" : "passport",
"title": "Unexpired US Passport or Passport Card"
}
]
}
Response
Ideally the response will include some indicator that maps to the provisioned exam record so we can tie the provisioned exam record to our appointment.
Webhook
We would like to be notified at specific points within the process of the exam being taken. Those points are outlined below in the note section of the status attribute. These webhooks would simply be an HTTP POST to a URL we provide whereby the InteRoads system would look for a HTTP 200 status code for a successful delivery.
Parameters
| Attribute | Datatype | Notes |
|---|---|---|
| sessionSid | string | This is the id that was sent to InteRoads during the provisioning process. |
| provisionedExamId | string | Note that the name of this attribute might change based on what you call this value in InteRoads. This should be the value of the provisioned exam in the InteRoads system. |
| status | string | The status of the exam, this will communicate to the SmarterProctoring system whether the exam was completed or not. The InteRoads statuses may vary, however ideal statuses would be as follows:
|
Keep in mind that given the 3 different statuses, there would be 3 points within the InteRoads system that would need to fire the hooks.
Sample Payload
{
"sessionSid":"ESb3fa751d9d7a4a909818116f1977664b",
"provisionedExamId:" : "123456789",
"status":"in-progress|complete|abandoned"
}