Arkimedes Network

Arkimedes Network provides the quickest, simplest way to bridge and engage talent with trust. Whether you're a tech-forward enterprise or an educational institution committed to upskilling, our API will seamlessly extend your software with new capabilities to (i) issue and verify secure employment and study certificates, (ii) simplify your talent workflows while reducing hiring bias, (iii) promote quality education and employment, and (iv) build a verifiable reputation for your brand. Note that this beta version is dynamic and subject to change. As we integrate it with our community of partners, we will be adding and modifying endpoints of this API to meet the needs of our diverse user base.

API Reference

Authentication

Error Handling

Metadata

Rate Limits

An employment certificate is a digitally-signed record that certifies an individual's work experience. It contains the employer's identity, job title, work location, grade, employment dates, status and the specific skills employed or acquired during the term of employment. These certificates are issued to the Web3 identity of an employee. And may be used by (i) enterprises and educational institutions to validate an individual's work experience and qualifications; (ii) individuals to build digital résumés; and (iii) third-party services as proof of employment status during business transactions that require such verification.

Employment Certificate

Issue an employment certificate

Retrieve registered employment certificate

An academic or study certificate is a digitally-signed record that certifies an educational achievement. It serves as proof that the holder has successfully completed a designated course of study, passed examinations, or met specified learning objectives. This certificate typically outlines the subject and level of study, issuing institution, identity of the instructor, area of specialization, grade achieved, duration of the course, and specific skills acquired. Issued to a Web3 identity, study certificates (i) enable employers to validate an individual's educational background and (ii) allow individuals to create digital résumés that demonstrate their qualifications.

Study Certificate

Issue a study certificate

Retrieve registered study certificate

An employment verification eases the process of validating the authenticity and accuracy of an individual's professional experience. Said verification may be carried out by employers, educational institutions, and third-party services to ensure that individuals possess the necessary qualifications.

Employment Verification

Verify employment certificate

A study verification eases the process of validating the authenticity and accuracy of an individual's educational accomplishment. Said verification may be performed by employers or educational institutions when a candidate is pursuing further education or career opportunities.

Study Verification

Verify a study certificate

A verified review provides reliable information for prospective employees or students. It contains at least a rating and review date, and can be used to evaluate the quality and practices of an employer or educational institution.

Review

Submit a review

Retrieve a verifiable review

A QR code is a machine-readable optical label. It is used to encode the ID of an employment or study certificate, which can be used to retrieve said certificate.

QR Code

Retrieve a qr code image

A Web3 network is a blockchain network that supports smart contracts. It is used to identify the blockchain network on which certificate and reviews are issued.

Web3 Network

Retrieve a list of supported web3 networks

Retrieve details of a specific web3 network.

Arkimedes API

sandbox

Beta

Sandbox

<p class="slate-p" placeholder="Type / for widgets">Arkimedes Network provides the quickest, simplest way to bridge and engage talent with trust. Whether you&apos;re a tech-forward enterprise or an educational institution committed to upskilling, our API will seamlessly extend your software with new capabilities to (i) issue and verify secure employment and study certificates, (ii) simplify your talent workflows while reducing hiring bias, (iii) promote quality education and employment, and (iv) build a verifiable reputation for your brand. Note that this beta version is dynamic and subject to change. As we integrate it with our community of partners, we will be adding and modifying endpoints of this API to meet the needs of our diverse user base.</p>

<p class="slate-p" placeholder="Type / for widgets">The Arkimedes API, in its Beta version, employs API Keys for the authentication of requests. These keys serve as a bridge to validate and process your API calls. They can be conveniently managed and viewed within the <a href="https://dashboard.arkimedes.network/" target="_blank">Arkimedes Dashboard</a>. Note that each API Key you generate gets linked directly to your Organization ID.</p><h3 class="slate-h3">HTTPS Requirement</h3><p class="slate-p" placeholder="Type / for widgets">All API requests must be made over <a href="http://en.wikipedia.org/wiki/HTTP_Secure" target="_blank">HTTPS</a>. Any attempt to make requests over plain HTTP will be met with failure. Similarly, any API requests that lack proper authentication credentials will be denied. Your API requests should have the following headers:</p><p class="slate-p" placeholder="Type / for widgets"><span style="color:var(--light-text-content-color);font-size:12px" class="slate-color"><code style="color:var(--light-text-content-color);font-size:12px" class="slate-code"><strong style="color:var(--light-text-content-color);font-size:12px" class="slate-bold">Authorization</strong></code></span><span style="color:var(--light-text-content-color);font-size:12px" class="slate-color"><code style="color:var(--light-text-content-color);font-size:12px" class="slate-code">: Bearer ARKIMEDES_API_KEY</code></span></p><p class="slate-p" placeholder="Type / for widgets"><span style="color:var(--light-text-content-color);font-size:12px" class="slate-color"><code style="color:var(--light-text-content-color);font-size:12px" class="slate-code"><strong style="color:var(--light-text-content-color);font-size:12px" class="slate-bold">Arkimedes-Organization</strong></code></span><span style="color:var(--light-text-content-color);font-size:12px" class="slate-color"><code style="color:var(--light-text-content-color);font-size:12px" class="slate-code">: YOUR_ORG_ID</code></span></p><h3 class="slate-h3">Security</h3><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Your API key is a secret!</strong> Avoid sharing it with unauthorized individuals or exposing it in publicly accessible areas like GitHub or client-side environments (e.g., browsers, apps). When your application is live and running, ensure that all requests to the Arkimedes API are channeled through your backend server. This method allows you to load your API key securely, either from an environment variable or a dedicated key management service.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

The Arkimedes API, in its Beta version, employs API Keys for the authentication of requests. These keys serve as a bridge to validate and process your API calls. They can be conveniently managed and viewed within the 

. Note that each API Key you generate gets linked directly to your Organization ID.

. Any attempt to make requests over plain HTTP will be met with failure. Similarly, any API requests that lack proper authentication credentials will be denied. Your API requests should have the following headers:

<p class="slate-p" placeholder="Type / for widgets">Arkimedes employs conventional HTTP response codes to denote the outcome of an API request. In general:</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><span style="background-color:#EFEFEF" class="slate-backgroundColor">2xx</span> codes: These indicate success. Your request was understood and processed accordingly.</div></li><li class="slate-li"><div style="position:relative"><span style="background-color:#EFEFEF" class="slate-backgroundColor">4xx</span> codes: These represent client errors, signaling that the request was formatted incorrectly or was inappropriate given the provided data. Often, these errors can be rectified by modifying the request. Notably, some 4xx errors will come paired with an error code, offering a concise explanation for the error encountered.</div></li><li class="slate-li"><div style="position:relative"><span style="background-color:#EFEFEF" class="slate-backgroundColor">5xx</span> codes: If you see these, something has gone wrong on Arkimedes&apos; end. These suggest that there was an issue with our servers processing your request. Check out our <a href="https://arkimedes.network/status" target="_self">status page</a> to get updates on how our systems are doing.</div></li></ul><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">We recommend handling API responses programmatically to ensure smooth user experiences and to address any errors or issues that may arise efficiently.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

Arkimedes employs conventional HTTP response codes to denote the outcome of an API request. In general:

The request succeeded. Everything worked as expected.

200 - OK

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., invalid request syntax).

400 - Bad request

Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.

401 - Unauthorized

The API KEY does not have access rights to the content. Unlike 401 Unauthorized, the client's identity is known to the server.

403 - Forbidden

The client has sent too many requests in a given amount of time ("rate limiting").

429 - Too Many Requests

500 - Internal Server Error

<p class="slate-p" placeholder="Type / for widgets">Arkimedes Certificates offer a metadata parameter. This parameter allows for the attachment of arbitrary key-value pairs to these Arkimedes objects. The metadata field accommodates up to 5 keys. Each key name can be a maximum of 20 characters in length, and the values can extend up to 100 characters.</p><p class="slate-p" placeholder="Type / for widgets">The primary purpose of metadata is to store supplementary, structured details regarding an object. For instance, an educational institution might choose to store a unique course code or identifier from their internal system as metadata on a certificate. Arkimedes does not inherently utilize the metadata for its internal processes, meaning it won&apos;t influence the core functionality of the certificate. However, users may not see this metadata unless explicitly presented to them.</p><div  data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets">Please exercise caution and avoid storing any sensitive data  in the metadata field.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p>

Arkimedes Certificates offer a metadata parameter. This parameter allows for the attachment of arbitrary key-value pairs to these Arkimedes objects. The metadata field accommodates up to 5 keys. Each key name can be a maximum of 20 characters in length, and the values can extend up to 100 characters.

The primary purpose of metadata is to store supplementary, structured details regarding an object. For instance, an educational institution might choose to store a unique course code or identifier from their internal system as metadata on a certificate. Arkimedes does not inherently utilize the metadata for its internal processes, meaning it won't influence the core functionality of the certificate. However, users may not see this metadata unless explicitly presented to them.

<p class="slate-p" placeholder="Type / for widgets">If your ARKIMEDES_API_KEY makes a lot of requests in a short period of time, then our requests may receive a 429 error response from Arkimedes. This indicates that your ARKIMEDES_API_KEY has reached our API <em class="slate-italic">rate limit</em>. The API has rate limits in order to keep our API reliable and to help third-party developers use the API in a responsible way. The limit varies depending on whether your integration is in beta mode or extended quota mode.</p>

If your ARKIMEDES_API_KEY makes a lot of requests in a short period of time, then our requests may receive a 429 error response from Arkimedes. This indicates that your ARKIMEDES_API_KEY has reached our API 

. The API has rate limits in order to keep our API reliable and to help third-party developers use the API in a responsible way. The limit varies depending on whether your integration is in beta mode or extended quota mode.

<p class="slate-p" placeholder="Type / for widgets">An employment certificate is a digitally-signed record that certifies an individual&apos;s work experience. It contains the employer&apos;s identity, job title, work location, grade, employment dates, status and the specific skills employed or acquired during the term of employment. These certificates are issued to the Web3 identity of an employee. And may be used by (i) enterprises and educational institutions to validate an individual&apos;s work experience and qualifications; (ii) individuals to build digital résumés; and (iii) third-party services as proof of employment status during business transactions that require such verification.</p>

<p class="slate-p" placeholder="Type / for widgets">An academic or study certificate is a digitally-signed record that certifies an educational achievement. It serves as proof that the holder has successfully completed a designated course of study, passed examinations, or met specified learning objectives. This certificate typically outlines the subject and level of study, issuing institution, identity of the instructor, area of specialization, grade achieved, duration of the course, and specific skills acquired. Issued to a Web3 identity, study certificates (i) enable employers to validate an individual&apos;s educational background and (ii) allow individuals to create digital résumés that demonstrate their qualifications.</p>

<p class="slate-p" placeholder="Type / for widgets">An employment verification eases the process of validating the authenticity and accuracy of an individual&apos;s professional experience. Said verification may be carried out by employers, educational institutions, and third-party services to ensure that individuals possess the necessary qualifications.</p>

<p class="slate-p" placeholder="Type / for widgets">A study verification eases the process of validating the authenticity and accuracy of an individual&apos;s educational accomplishment. Said verification may be performed by employers or educational institutions when a candidate is pursuing further education or career opportunities.</p>

<p class="slate-p" placeholder="Type / for widgets">A verified review provides reliable information for prospective employees or students. It contains at least a rating and review date, and can be used to evaluate the quality and practices of an employer or educational institution.</p>

<p class="slate-p" placeholder="Type / for widgets">A QR code is a machine-readable optical label. It is used to encode the ID of an employment or study certificate, which can be used to retrieve said certificate.</p>

<p class="slate-p" placeholder="Type / for widgets">A Web3 network is a blockchain network that supports smart contracts. It is used to identify the blockchain network on which certificate and reviews are issued.</p>

Sections