sandbox

## Sections
• [API Reference](https://app.theneo.io/arkimedes-network/sandbox/api-reference.md): 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.
  • [Authentication](https://app.theneo.io/arkimedes-network/sandbox/api-reference/authentication.md): 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 Arkimedes Dashboard . Note that each API Key you generate gets linked directly to your Organization ID. HTTPS Requirement All API requests must be made over HTTPS . 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: Authorization : Bearer ARKIMEDES_API_KEY Arkimedes-Organization : YOUR_ORG_ID Security Your API key is a secret! 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.
  • [Error Handling](https://app.theneo.io/arkimedes-network/sandbox/api-reference/error-handling.md): Arkimedes employs conventional HTTP response codes to denote the outcome of an API request. In general: 2xx codes: These indicate success. Your request was understood and processed accordingly. 4xx 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. 5xx codes: If you see these, something has gone wrong on Arkimedes' end. These suggest that there was an issue with our servers processing your request. Check out our status page to get updates on how our systems are doing. We recommend handling API responses programmatically to ensure smooth user experiences and to address any errors or issues that may arise efficiently.
  • [Metadata](https://app.theneo.io/arkimedes-network/sandbox/api-reference/metadata.md): 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. Please exercise caution and avoid storing any sensitive data in the metadata field.
  • [Rate Limits](https://app.theneo.io/arkimedes-network/sandbox/api-reference/rate-limits.md): 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 rate limit . 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.
• [Employment Certificate](https://app.theneo.io/arkimedes-network/sandbox/employment-certificate.md): 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.
  • [Issue an employment certificate](https://app.theneo.io/arkimedes-network/sandbox/employment-certificate/issue-an-employment-certificate.md)
  • [Retrieve registered employment certificate](https://app.theneo.io/arkimedes-network/sandbox/employment-certificate/retrieve-registered-employment-certificate.md)
• [Study Certificate](https://app.theneo.io/arkimedes-network/sandbox/study-certificate.md): 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.
  • [Issue a study certificate](https://app.theneo.io/arkimedes-network/sandbox/study-certificate/issue-a-study-certificate.md)
  • [Retrieve registered study certificate](https://app.theneo.io/arkimedes-network/sandbox/study-certificate/retrieve-registered-study-certificate.md)
• [Employment Verification](https://app.theneo.io/arkimedes-network/sandbox/employment-verification.md): 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.
  • [Verify employment certificate](https://app.theneo.io/arkimedes-network/sandbox/employment-verification/verify-employment-certificate.md)
• [Study Verification](https://app.theneo.io/arkimedes-network/sandbox/study-verification.md): 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.
  • [Verify a study certificate](https://app.theneo.io/arkimedes-network/sandbox/study-verification/verify-a-study-certificate.md)
• [Review](https://app.theneo.io/arkimedes-network/sandbox/review.md): 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.
  • [Submit a review](https://app.theneo.io/arkimedes-network/sandbox/review/submit-a-review.md)
  • [Retrieve a verifiable review](https://app.theneo.io/arkimedes-network/sandbox/review/retrieve-a-verifiable-review.md)
• [QR Code](https://app.theneo.io/arkimedes-network/sandbox/qr-code.md): 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.
  • [Retrieve a qr code image](https://app.theneo.io/arkimedes-network/sandbox/qr-code/retrieve-a-qr-code-image.md)
• [Web3 Network](https://app.theneo.io/arkimedes-network/sandbox/web3-network.md): 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.
  • [Retrieve a list of supported web3 networks](https://app.theneo.io/arkimedes-network/sandbox/web3-network/retrieve-a-list-of-supported-web3-networks.md)
  • [Retrieve details of a specific web3 network.](https://app.theneo.io/arkimedes-network/sandbox/web3-network/retrieve-details-of-a-specific-web3-network.md)