Id Repository Identity Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Id Repository Identity Service

id-repo-draft-controller

Id Repo Draft Controller

getDraft

path Parameters

registrationId

required

string

query Parameters

fingerExtractionFormat	string
irisExtractionFormat	string
faceExtractionFormat	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

hasDraft

path Parameters

registrationId

required

string

Responses

updateDraft

path Parameters

registrationId

required

string

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
],
"registrationId": "string",
"uin": "string",
"biometricReferenceId": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

publishDraft

path Parameters

registrationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

extractBiometrics

path Parameters

registrationId

required

string

query Parameters

fingerExtractionFormat	string
irisExtractionFormat	string
faceExtractionFormat	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

discardDraft

path Parameters

registrationId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

createDraft

path Parameters

registrationId

required

string

query Parameters

UIN

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

vid-event-callback-controller

Vid Event Callback Controller

handleVidEvent

Request Body schema: application/json

publisher	string
topic	string
publishedOn	string
	object (Event)

Responses

Request samples

Payload

Content type

application/json

{"publisher": "string",
"topic": "string",
"publishedOn": "string",
"event": {"id": "string",
"transactionId": "string",
"type": {"namespace": "string",
"name": "string"
},
"timestamp": "string",
"dataShareUri": "string",
"data": {"property1": { },
"property2": { }
}
}
}

id-repo-controller

Id Repo Controller

retrieveIdentity

path Parameters

id

required

string

query Parameters

type	string
idType	string
fingerExtractionFormat	string
irisExtractionFormat	string
faceExtractionFormat	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Authenticate Internal Request

Request Body schema: application/json;charset=UTF-8

id	string
version	string
requestTime	string
consentObtained	boolean
individualId	string
individualIdType	string
	Array of objects (AuthtypeStatus) [ items ]

Responses

Request samples

Payload

Content type

application/json;charset=UTF-8

{"id": "string",
"version": "string",
"requestTime": "string",
"consentObtained": true,
"individualId": "string",
"individualIdType": "string",
"request": [{"authType": "string",
"authSubType": "string",
"locked": true,
"unlockForSeconds": 0,
"requestId": "string",
"metadata": {"property1": { },
"property2": { }
}
}
]
}

Response samples

200

Content type

application/json;charset=UTF-8

[{"cause": {"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
},
"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"operation": "string",
"message": "string",
"errorTexts": ["string"
],
"errorText": "string",
"codes": ["string"
],
"errorCode": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
}
]

Authtype Status Request

path Parameters

ID

required

string

Responses

Response samples

200

Content type

application/json

[{"cause": {"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
},
"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"operation": "string",
"message": "string",
"errorTexts": ["string"
],
"errorText": "string",
"codes": ["string"
],
"errorCode": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
}
]

Authtype Status Request Deprecated

Authtype Status Request

path Parameters

ID required	string
IDType required	string

Responses

Response samples

200

Content type

application/json

[{"cause": {"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
},
"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"operation": "string",
"message": "string",
"errorTexts": ["string"
],
"errorText": "string",
"codes": ["string"
],
"errorCode": "string",
"suppressed": [{"stackTrace": [{"classLoaderName": "string",
"moduleName": "string",
"moduleVersion": "string",
"methodName": "string",
"fileName": "string",
"lineNumber": 0,
"className": "string",
"nativeMethod": true
}
],
"message": "string",
"localizedMessage": "string"
}
],
"localizedMessage": "string"
}
]

addIdentity

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
],
"registrationId": "string",
"uin": "string",
"biometricReferenceId": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

updateIdentity

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (RequestDTO)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
],
"registrationId": "string",
"uin": "string",
"biometricReferenceId": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"status": "string",
"identity": { },
"documents": [{"category": "string",
"value": "string"
}
],
"verifiedAttributes": ["string"
]
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Home

Id Repository Identity Service (1.0)

id-repo-draft-controller

getDraft

path Parameters

query Parameters

Responses

Response samples

hasDraft

path Parameters

Responses

updateDraft

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

publishDraft

path Parameters

Responses

Response samples

extractBiometrics

path Parameters

query Parameters

Responses

Response samples

discardDraft

path Parameters

Responses

Response samples

createDraft

path Parameters

query Parameters

Responses

Response samples

vid-event-callback-controller

handleVidEvent

Request Body schema: application/json

Responses

Request samples

id-repo-controller

retrieveIdentity

path Parameters

query Parameters

Responses

Response samples

Authenticate Internal Request

Request Body schema: application/json;charset=UTF-8

Responses

Request samples

Response samples

Authtype Status Request

path Parameters

Responses

Response samples

Authtype Status Request Deprecated

path Parameters

Responses

Response samples

addIdentity

Request Body schema: application/json

Responses

Request samples

Response samples

updateIdentity

Request Body schema: application/json

Responses

Request samples

Response samples

Home