/
ID Schema

ID Schema

Owned by Rounak Nayak (Unlicensed)
Last updated: Feb 21, 2022
3 min read

Data Types

  • simpleType - stores multiple strings with language code

  • documentType - stores document file details such as,

    • format - extension

    • type - document category type

    • value - the name of the document

    • refNumber - reference number of the document

  • biometricType - to store biometrics file details such as,

    • format - format of the file

    • version - version of the file

    • value - the name of the file

  • string

  • number

Attributes

  • bioAttributes - array of biometric subtypes to be captured 

  • fieldCategory - pvt

  • fieldType - dynamic or default

  • $ref - if we have a reference data type

  • type - data type

  • validator - data validator

    • langCode - language specific validator

    • validator. - validator rule

    • arguments - additional arguments for the validator

    • type - type of validator

  • minimum - minimum value in case of number data type

Sample ID Schema

{ "$schema":"http:\/\/json-schema.org\/draft-07\/schema#", "description":"string", "additionalProperties":false, "title":"string", "type":"object", "definitions":{ "simpleType":{ "uniqueItems":true, "additionalItems":false, "type":"array", "items":{ "additionalProperties":false, "type":"object", "required":[ "language", "value" ], "properties":{ "language":{ "type":"string" }, "value":{ "type":"string" } } } }, "documentType":{ "additionalProperties":false, "type":"object", "required":[ "format", "type", "value" ], "properties":{ "refNumber":{ "type":"string" }, "format":{ "type":"string" }, "type":{ "type":"string" }, "value":{ "type":"string" } } }, "biometricsType":{ "additionalProperties":false, "type":"object", "properties":{ "format":{ "type":"string" }, "version":{ "type":"number", "minimum":0 }, "value":{ "type":"string" } } } }, "properties":{ "identity":{ "additionalProperties":false, "type":"object", "required":[ "fullName", "gender", "dateOfBirth", "phone", "email", "residenceStatus", "state", "city", "locality", "postalCode", "proofOfConsent", "proofOfIdentity", "proofOfDateOfBirth" ], "properties":{ "proofOfAddress":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "gender":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"", "fieldType":"dynamic", "$ref":"#\/definitions\/simpleType" }, "city":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{0,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/simpleType" }, "proofOfConsent":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "postalCode":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{0,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "type":"string", "fieldType":"default" }, "proofOfException-1":{ "bioAttributes":[ ], "fieldCategory":"evidence", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "individualBiometrics":{ "bioAttributes":[ "leftEye", "rightEye", "rightIndex", "rightLittle", "rightRing", "rightMiddle", "leftIndex", "leftLittle", "leftRing", "leftMiddle", "leftThumb", "rightThumb", "face" ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/biometricsType" }, "proofOfDateOfBirth":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "residenceStatus":{ "bioAttributes":[ ], "fieldCategory":"kyc", "format":"none", "fieldType":"dynamic", "$ref":"#\/definitions\/simpleType" }, "state":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{0,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/simpleType" }, "email":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^[A-Za-z0-9_\\-]+(\\.[A-Za-z0-9_]+)*@[A-Za-z0-9_-]+(\\.[A-Za-z0-9_]+)*(\\.[a-zA-Z]{2,})$", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "type":"string", "fieldType":"default" }, "address":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{0,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/simpleType" }, "parentOrGuardianRID":{ "bioAttributes":[ ], "fieldCategory":"evidence", "format":"none", "type":"string", "fieldType":"default" }, "parentOrGuardianBiometrics":{ "bioAttributes":[ "leftEye", "rightEye", "rightIndex", "rightLittle", "rightRing", "rightMiddle", "leftIndex", "leftLittle", "leftRing", "leftMiddle", "leftThumb", "rightThumb", "face" ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/biometricsType" }, "locality":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{0,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/simpleType" }, "fullName":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(?=.{3,50}$).*", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/simpleType" }, "dateOfBirth":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"^(1869|18[7-9][0-9]|19[0-9][0-9]|20[0-9][0-9])\/([0][1-9]|1[0-2])\/([0][1-9]|[1-2][0-9]|3[0-1])$", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "type":"string", "fieldType":"default" }, "individualAuthBiometrics":{ "bioAttributes":[ "leftEye", "rightEye", "rightIndex", "rightLittle", "rightRing", "rightMiddle", "leftIndex", "leftLittle", "leftRing", "leftMiddle", "leftThumb", "rightThumb", "face" ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/biometricsType" }, "parentOrGuardianUIN":{ "bioAttributes":[ ], "fieldCategory":"evidence", "format":"none", "type":"string", "fieldType":"default" }, "proofOfIdentity":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "IDSchemaVersion":{ "bioAttributes":[ ], "fieldCategory":"none", "format":"none", "type":"number", "fieldType":"default", "minimum":0 }, "proofOfException":{ "bioAttributes":[ ], "fieldCategory":"evidence", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "phone":{ "bioAttributes":[ ], "validators":[ { "langCode":null, "validator":"([6-9]{1})([0-9]{9})$", "arguments":[ ], "type":"regex" } ], "fieldCategory":"pvt", "format":"none", "type":"string", "fieldType":"default" }, "proofOfRelationship":{ "bioAttributes":[ ], "fieldCategory":"pvt", "format":"none", "fieldType":"default", "$ref":"#\/definitions\/documentType" }, "UIN":{ "bioAttributes":[ ], "fieldCategory":"none", "format":"none", "type":"string", "fieldType":"default" } } } } }

 

Add label

Related content