Upsert a Verifiable Comprehensive Learner Record (CLR)
curl --request POST \
--url https://api.alpha-1edtech.ai/ims/clr/v2p0/credentials/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
},
"name": "<string>",
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"type": [
"<string>"
],
"verifiableCredential": [
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
},
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"id": "<string>"
},
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
]
}
],
"id": "<string>",
"identifier": [
{
"type": "<string>",
"identityHash": "<string>",
"identityType": "<string>",
"hashed": true,
"salt": "<string>"
}
],
"achievement": [
{
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"criteria": {
"id": "<string>",
"narrative": "<string>"
}
}
],
"association": [
{
"type": "<string>",
"sourceId": "<string>",
"targetId": "<string>"
}
]
},
"description": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
],
"credentialSchema": [
{
"id": "<string>",
"type": "<string>"
}
]
}
'{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
},
"name": "<string>",
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"type": [
"<string>"
],
"verifiableCredential": [
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
},
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"id": "<string>"
},
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
]
}
],
"id": "<string>",
"identifier": [
{
"type": "<string>",
"identityHash": "<string>",
"identityType": "<string>",
"hashed": true,
"salt": "<string>"
}
],
"achievement": [
{
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"criteria": {
"id": "<string>",
"narrative": "<string>"
},
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"creator": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
}
}
],
"association": [
{
"type": "<string>",
"sourceId": "<string>",
"targetId": "<string>"
}
]
},
"description": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
],
"credentialSchema": [
{
"id": "<string>",
"type": "<string>"
}
]
}Credentials
Upsert a Verifiable Comprehensive Learner Record (CLR)
Upserts a Comprehensive Learner Record (CLR) v2.0 compliant Verifiable Credential (ClrCredential). This platform acts as the ‘publisher’ of the overarching ClrCredential, digitally signing it to ensure its authenticity and integrity. The ClrCredential packages a collection of individual assertions (e.g., AchievementCredentials, OpenBadgeCredentials, or other Verifiable Credentials) about the learner. The learner’s identity information is embedded within the ‘credentialSubject’ of the main ClrCredential. The resulting CLR includes a cryptographic proof (e.g., DataIntegrityProof or JsonWebSignature2020) allowing any verifier to confirm that the CLR was issued by this platform and has not been tampered with since its issuance.
POST
/
ims
/
clr
/
v2p0
/
credentials
Upsert a Verifiable Comprehensive Learner Record (CLR)
curl --request POST \
--url https://api.alpha-1edtech.ai/ims/clr/v2p0/credentials/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
},
"name": "<string>",
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"type": [
"<string>"
],
"verifiableCredential": [
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"email": "jsmith@example.com"
},
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"id": "<string>"
},
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
]
}
],
"id": "<string>",
"identifier": [
{
"type": "<string>",
"identityHash": "<string>",
"identityType": "<string>",
"hashed": true,
"salt": "<string>"
}
],
"achievement": [
{
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"criteria": {
"id": "<string>",
"narrative": "<string>"
}
}
],
"association": [
{
"type": "<string>",
"sourceId": "<string>",
"targetId": "<string>"
}
]
},
"description": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
],
"credentialSchema": [
{
"id": "<string>",
"type": "<string>"
}
]
}
'{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
},
"name": "<string>",
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"type": [
"<string>"
],
"verifiableCredential": [
{
"@context": [
"<string>"
],
"id": "<string>",
"type": [
"<string>"
],
"issuer": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
},
"validFrom": "2023-11-07T05:31:56Z",
"credentialSubject": {
"id": "<string>"
},
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
]
}
],
"id": "<string>",
"identifier": [
{
"type": "<string>",
"identityHash": "<string>",
"identityType": "<string>",
"hashed": true,
"salt": "<string>"
}
],
"achievement": [
{
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"description": "<string>",
"criteria": {
"id": "<string>",
"narrative": "<string>"
},
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"creator": {
"id": "<string>",
"type": [
"<string>"
],
"name": "<string>",
"url": "<string>",
"phone": "<string>",
"description": "<string>",
"image": {
"id": "<string>",
"type": "<string>",
"caption": "<string>"
},
"email": "jsmith@example.com"
}
}
],
"association": [
{
"type": "<string>",
"sourceId": "<string>",
"targetId": "<string>"
}
]
},
"description": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"proof": [
{
"type": "<string>",
"proofPurpose": "<string>",
"verificationMethod": "<string>",
"created": "2023-11-07T05:31:56Z",
"proofValue": "<string>",
"cryptosuite": "<string>"
}
],
"credentialSchema": [
{
"id": "<string>",
"type": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.timeback.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Credential successfully updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I