Credentials

List of endpoints related to the credentials.

Endpoints

Obtain credential(s)

GET https://dl3arn.com/api/v1/credentials

Get credentials from a collection using the address of the collection. Using the credential ID returns only 1 credential.

Query Parameters

Name	Type	Description
contract*	String	Contract address
credential_id	String	Credential ID

200: OK

{
    data: CredentialModel | CredentialModel[],
    error: null,
    status: 200,
    success: true
}

404: Not Found

{
    data: null;
    error: { code: string; message: string; };
    status: 404;
    success: false;
}

Create credential(s)

POST https://dl3arn.com/api/v1/credentials

Create a new credential.

Query Parameters

Name	Type	Description
contract*	String	Contract Address

Headers

Name	Type	Description
Authorization*	Bearer	API Key
Content-Type*	String	multipart/form-data

Request Body

Name	Type	Description
file*	File	Imagen de la nueva credencial
to*	String	Email de la persona que recibe el NFT
name*	String	Nombre de la credencial
credential_id	String	ID personalizado de la credencial

200: OK

{
    data: CredentialModel,
    error: null,
    status: 200,
    success: true
}

400: Bad Request

{
    data: null;
    error: {
        code: string;
        message: string;
        inputs: ({ value: unknown; message: string } | null)[] 
    };
    status: 400;
    success: false;
}

Claim credential(s)

PUT https://dl3arn.com/api/v1/credentials

Endpoint to claim the NFT, using the address of the user and the ID of the credential.

Path Parameters

Name	Type	Description
id*	String
address	String

200: OK

{
    data: { 
        tx_hash: string;
        credential: CredentialModel;
    };
    error: null;
    success: true;
    status: 200;
}

Validate Credential(s)

GET https://dl3arn.com/api/v1/credentials/validate/[transaction_hash]

Validate credentials using the NFT creation hash and the collection address.

Path Parameters

Name	Type	Description
transaction_hash*	String	Transaction hash

Query Parameters

Name	Type	Description
contract*	String	Collection Address.

200: OK

{
    data: {
        events: { tx_hash: string; from: string; to: string }[]
        validated: boolean;
    };
    error: null;
    status: 200;
    success: true;
}

Models used

pageCredential Model