Validate methodResponse as per the specification
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ValidationInputDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "testCaseType": "string",
- "testName": "string",
- "specVersion": "string",
- "testId": "string",
- "responseSchema": "string",
- "methodResponse": "string",
- "methodRequest": "string",
- "methodName": "string",
- "extraInfoJson": "string",
- "validatorDefs": [
- {
- "name": "string",
- "description": "string"
}
], - "isNegativeTestcase": true
}
}
Validate methodRequest as per the specification
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ValidateRequestSchemaDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "testCaseType": "string",
- "testName": "string",
- "specVersion": "string",
- "testDescription": "string",
- "requestSchema": "string",
- "methodRequest": "string"
}
}
The user must have the CTK_ADMIN role in order to save test cases.
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (TestCaseRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "testCases": [
- {
- "testCaseType": "string",
- "testId": "string",
- "specVersion": "string",
- "testName": "string",
- "testDescription": "string",
- "androidTestDescription": "string",
- "inactiveForAndroid": "string",
- "methodName": [
- "string"
], - "requestSchema": [
- "string"
], - "responseSchema": [
- "string"
], - "validatorDefs": [
- [
- {
- "name": "string",
- "description": "string"
}
]
], - "otherAttributes": {
- "purpose": [
- "string"
], - "biometricTypes": [
- "string"
], - "deviceSubTypes": [
- "string"
], - "segments": [
- "string"
], - "exceptions": [
- "string"
], - "requestedScore": "string",
- "bioCount": "string",
- "deviceSubId": "string",
- "timeout": "string",
- "transactionId": "string",
- "invalidRequestAttribute": "string",
- "ageGroup": "string",
- "gender": "string",
- "occupation": "string",
- "race": "string",
- "testCaseRepeatCount": "string",
- "modalities": [
- "string"
], - "sdkPurpose": [
- "string"
], - "convertSourceFormat": "string",
- "convertTargetFormat": "string",
- "insertCount": "string",
- "insertReferenceId": "string",
- "identifyReferenceId": "string",
- "identifyGalleryIds": [
- "string"
], - "expectedDuplicateCount": "string",
- "expectedFailureReason": "string",
- "resumeBtn": true,
- "resumeAgainBtn": true,
- "keyRotationTestCase": true,
- "hashValidationTestCase": true,
- "qualityAssessmentTestCase": true,
- "bulkInsert": true
}, - "isNegativeTestcase": true,
- "inactive": true
}
]
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "testCases": {
- "property1": "string",
- "property2": "string"
}
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Generate request for SDK
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SdkRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "methodName": "string",
- "testcaseId": "string",
- "modalities": [
- "string"
], - "bioTestDataName": "string",
- "birsForProbe": "string",
- "convertSourceFormat": "string",
- "convertTargetFormat": "string"
}
}
Generate request for SDK From BIR's
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SdkRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "methodName": "string",
- "testcaseId": "string",
- "modalities": [
- "string"
], - "bioTestDataName": "string",
- "birsForProbe": "string",
- "convertSourceFormat": "string",
- "convertTargetFormat": "string"
}
}
type any of these [MOSIP_DEFAULT, SCHEMAS, SCHEMAS_SBI, SCHEMAS_SDK, SCHEMAS_ABIS] & version as per SBI/SDK/ABIS schema version
type required | string |
version | string |
file required | string <binary> |
Update test run
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (TestRunDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "collectionId": "string",
- "runDtimes": "2019-08-24T14:15:22Z",
- "executionDtimes": "2019-08-24T14:15:22Z",
- "runConfigurationJson": "string",
- "executionStatus": "string",
- "runStatus": "string"
}
}
Add test run
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (TestRunDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "collectionId": "string",
- "runDtimes": "2019-08-24T14:15:22Z",
- "executionDtimes": "2019-08-24T14:15:22Z",
- "runConfigurationJson": "string",
- "executionStatus": "string",
- "runStatus": "string"
}
}
Add test run details
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (TestRunDetailsDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "runId": "string",
- "testcaseId": "string",
- "methodId": "string",
- "methodUrl": "string",
- "methodRequest": "string",
- "methodResponse": "string",
- "executionStatus": "string",
- "resultStatus": "string",
- "resultDescription": "string",
- "testDataSource": "string"
}
}
Update SDK project details
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SdkProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sdkVersion": "string",
- "url": "string",
- "sdkHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "purpose": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sdkVersion": "string",
- "url": "string",
- "sdkHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "purpose": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Add new SDK project
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SdkProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sdkVersion": "string",
- "url": "string",
- "sdkHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "purpose": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sdkVersion": "string",
- "url": "string",
- "sdkHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "purpose": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Update SBI project details
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SbiProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sbiVersion": "string",
- "purpose": "string",
- "deviceType": "string",
- "deviceSubType": "string",
- "isAndroidSbi": "string",
- "deviceImage1": "string",
- "deviceImage2": "string",
- "deviceImage3": "string",
- "deviceImage4": "string",
- "sbiHash": "string",
- "websiteUrl": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sbiVersion": "string",
- "purpose": "string",
- "deviceType": "string",
- "deviceSubType": "string",
- "isAndroidSbi": "string",
- "deviceImage1": "string",
- "deviceImage2": "string",
- "deviceImage3": "string",
- "deviceImage4": "string",
- "sbiHash": "string",
- "websiteUrl": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Add new SBI project
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (SbiProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sbiVersion": "string",
- "purpose": "string",
- "deviceType": "string",
- "deviceSubType": "string",
- "isAndroidSbi": "string",
- "deviceImage1": "string",
- "deviceImage2": "string",
- "deviceImage3": "string",
- "deviceImage4": "string",
- "sbiHash": "string",
- "websiteUrl": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "sbiVersion": "string",
- "purpose": "string",
- "deviceType": "string",
- "deviceSubType": "string",
- "isAndroidSbi": "string",
- "deviceImage1": "string",
- "deviceImage2": "string",
- "deviceImage3": "string",
- "deviceImage4": "string",
- "sbiHash": "string",
- "websiteUrl": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Update ABIS project details
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (AbisProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "url": "string",
- "username": "string",
- "password": "string",
- "inboundQueueName": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z",
- "outboundQueueName": "string",
- "modality": "string",
- "abisHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "abisVersion": "string"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "url": "string",
- "username": "string",
- "password": "string",
- "inboundQueueName": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z",
- "outboundQueueName": "string",
- "modality": "string",
- "abisHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "abisVersion": "string"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Add new ABIS project
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (AbisProjectDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "url": "string",
- "username": "string",
- "password": "string",
- "inboundQueueName": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z",
- "outboundQueueName": "string",
- "modality": "string",
- "abisHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "abisVersion": "string"
}
}
{- "id": "string",
- "version": "string",
- "responsetime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "response": {
- "id": "string",
- "name": "string",
- "projectType": "string",
- "url": "string",
- "username": "string",
- "password": "string",
- "inboundQueueName": "string",
- "partnerId": "string",
- "orgName": "string",
- "crBy": "string",
- "crDate": "2019-08-24T14:15:22Z",
- "upBy": "string",
- "updDate": "2019-08-24T14:15:22Z",
- "outboundQueueName": "string",
- "modality": "string",
- "abisHash": "string",
- "websiteUrl": "string",
- "bioTestDataFileName": "string",
- "abisVersion": "string"
}, - "errors": [
- {
- "errorCode": "string",
- "message": "string"
}
]
}
Partner can submit their report for admin review
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Admin can reject partner's report
partnerId required | string |
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Check whether the report has already been submitted.
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Download partner submitted report for review
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Get partner report by partner id
partnerId required | string |
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Generate draft report for compliance collection
origin required | string |
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Generate draft report for quality assessment collection
origin required | string |
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Admin can approve partner's report
partnerId required | string |
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (ReportRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectType": "string",
- "projectId": "string",
- "collectionId": "string",
- "testRunId": "string",
- "adminComments": "string",
- "partnerComments": "string"
}
}
Add selected testcases for collection
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | Array of objects (CollectionTestCaseDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": [
- {
- "collectionId": "string",
- "testCaseId": "string"
}
]
}
Add new collection
id | string |
version | string |
requesttime | string <date-time> |
metadata | object |
required | object (CollectionRequestDto) |
{- "id": "string",
- "version": "string",
- "requesttime": "2019-08-24T14:15:22Z",
- "metadata": { },
- "request": {
- "projectId": "string",
- "projectType": "string",
- "collectionName": "string",
- "collectionType": "string"
}
}