Skip to main content

GET /issuer/schema/:schemaName

To retrieve Schema details.

{{baseUrl}}/issuer/schema/:schemaName

Headers:

X-API-Key: {{apiKey}}

Params: Path Variables:

schemaName: NewMemberType:1

Click Send and wait for the response.

Sample Response Body:

{
"success": true,
"data": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "NewMemberType",
"description": "Membership Document for GBA Credential",
"type": "object",
"properties": {
"userName": {
"type": "string",
"description": "Username of the user",
"maxLength": "12"
},
"firstName": {
"type": "string",
"pattern": "[a-zA-Z]+$",
"description": "First name of the user",
"maxLength": "12"
},
"lastName": {
"type": "string",
"pattern": "[a-zA-Z]+$",
"description": "Last name of the user",
"maxLength": "12"
},
"email": {
"type": "string",
"format": "email",
"description": "Email of the user"
},
"membershipType": {
"type": "string",
"pattern": "[a-zA-Z]+$",
"description": "Membership Type of the user"
},
"salary": {
"type": "integer",
"description": "Salary of the user"
},
"dateOfBirth": {
"type": "date",
"format": "date-time",
"description": "Date of Birth of the user"
}
},
"required": [
"userName",
"firstName",
"lastName",
"email",
"membershipType",
"salary",
"dateOfBirth"
],
"expiration": {
"value": 1,
"unit": "years"
},
"dependantSchemas": []
},
"message": "Schema retrieved",
"status": 200
}