API endpoints to use.
The following API endpoints are references on how you would implement such microservices for your own business requirements. They are NOT to be relied on, for any of your production related needs. We reserve the right to change or shutdown the API anytime.
There is a limit of
6mbon maximum request body size. Revising your OpenAttestation document file size might help if you encounter 413Payload Too Largeerrors.
Endpoint: https://tradetrust-functions.netlify.app/.netlify/functions/storage
POST
/storageuploads an encrypted OpenAttestation document/storage/:iduploads an encrypted OpenAttestation document with decrypt key from/storage/queue
// POST data example
{
"document": {
"version": "https://schema.openattestation.com/2.0/schema.json",
"network: {
"chain": "9a09ae01-f16a-466d-ad66-b42e6b07e225:string:ETH",
"chainId": "19ca73ed-e2cf-43ac-b104-3c43d2fc0680:string:5"
},
...rest
}
}
Document storage endpoint requires
network.chainIdfield in OA document.
The uploaded encrypted OpenAttestation documents will not be stored long term. They will be auto deleted after 30 days.
GET
/storage/:idreturns an encrypted OpenAttestation document/storage/queuereturns id and generated decrypt key
Endpoint: https://tradetrust-functions.netlify.app/.netlify/functions/verify
POST
/verifyverifies an OpenAttestation document on mainnet network/verify?network="maticmum"verifies an OpenAttestation document on maticmum network/verify?network="sepolia"verifies an OpenAttestation document on sepolia network/verify?network="xdcapothem"verifies an OpenAttestation document on xdcapothem network
// POST data example
{
"document": {
"version": "https://schema.openattestation.com/2.0/schema.json",
...rest
}
}
npm run start
The dummy value in API_KEY should work for local development purposes. For production API_KEY value, refer to netlify env variables at dashboard.