Compliance-Toolkit (1.0)

Download OpenAPI specification:Download

License: Mosip

Compliance Toolkit Services

test-cases-controller

Validate Response

Validate methodResponse as per the specification

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ValidationInputDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Validate Request

Validate methodRequest as per the specification

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ValidateRequestSchemaDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Save testcases

The user must have the CTK_ADMIN role in order to save test cases.

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TestCaseRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Get testcase

Get testcase by testId

path Parameters
testId
required
string

Responses

Get SDK testcases

Get SDK testcases by using the required fields given below.

query Parameters
specVersion
required
string
sdkPurpose
required
string

Responses

Get SBI testcases

Get SBI testcases by using the required fields given below.

query Parameters
specVersion
required
string
purpose
required
string
deviceType
required
string
deviceSubType
required
string
isAndroid
required
boolean

Responses

Get ABIS testcases

Get ABIS testcases based on the ABIS spec version

query Parameters
abisSpecVersion
required
string

Responses

Generate request for SDK

Generate request for SDK

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SdkRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Generate request for SDK From BIR's

Generate request for SDK From BIR's

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SdkRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

resource-management-controller

upload resource file

type any of these [MOSIP_DEFAULT, SCHEMAS, SCHEMAS_SBI, SCHEMAS_SDK, SCHEMAS_ABIS] & version as per SBI/SDK/ABIS schema version

query Parameters
type
required
string
version
string
Request Body schema:
file
required
string <binary>

Responses

Request samples

Content type
No sample

test-run-controller

Update test run

Update test run

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TestRunDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Get test run status

Get test run status by run id

path Parameters
runId
required
string

Responses

Get test run history

Get test run history for a collection

query Parameters
collectionId
required
string
pageNo
integer <int32>
Default: 0
pageSize
integer <int32>
Default: 10

Responses

Get test run details

Get test run details by run id

path Parameters
runId
required
string

Responses

Get partner test run details

Get partner test run details by partner id and run id

path Parameters
partnerId
required
string
runId
required
string

Responses

Get partner method details

Get partner method details

path Parameters
partnerId
required
string
runId
required
string
testcaseId
required
string
methodId
required
string

Responses

Get method details

Get method details based on the run id, testcase id and method id

path Parameters
runId
required
string
testcaseId
required
string
methodId
required
string

Responses

Delete test run

Delete testrun by run id

path Parameters
runId
required
string

Responses

Add test run

Add test run

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TestRunDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Add test run details

Add test run details

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TestRunDetailsDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

sdk-project-controller

Update SDK project

Update SDK project details

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SdkProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Get SDK project

Get SDK project by id

path Parameters
id
required
string

Responses

Add SDK project

Add new SDK project

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SdkProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

sbi-project-controller

Update SBI project

Update SBI project details

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SbiProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Get SBI project

Get SBI project by id

path Parameters
id
required
string

Responses

Get Encryption Key

Download the encryption key only for auth projects

Responses

Add SBI project

Add new SBI project

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SbiProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

abis-project-controller

Update ABIS project

Update ABIS project details

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (AbisProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Get ABIS project

Get ABIS project by id

path Parameters
id
required
string

Responses

Add ABIS project

Add new ABIS project

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (AbisProjectDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

report-controller

Submit the report for review

Partner can submit their report for admin review

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Reject partner report

Admin can reject partner's report

path Parameters
partnerId
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Check if report submitted

Check whether the report has already been submitted.

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Get submitted report

Download partner submitted report for review

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Get submitted report list

Get submitted report list

Responses

Get partner report list

Get partner report list by report status

path Parameters
reportStatus
required
string

Responses

Get partner report

Get partner report by partner id

path Parameters
partnerId
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Generate draft report

Generate draft report for compliance collection

header Parameters
origin
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Generate QA draft report

Generate draft report for quality assessment collection

header Parameters
origin
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Approve partner report

Admin can approve partner's report

path Parameters
partnerId
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ReportRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

abis-data-share-controller

Save data share token

Save data share token

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (DataShareSaveTokenRequest)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Invalidate data share token

Invalidate data share token

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (DataShareSaveTokenRequest)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Expire data share Url

Expire data share Url

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (DataShareExpireRequest)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Create data share Url

Create data share Url

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (DataShareRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

login-controller

logoutUser

query Parameters
redirecturi
required
string
cookie Parameters
Authorization
string

Responses

login

path Parameters
redirectURI
required
string
cookie Parameters
state
string

Responses

loginRedirect

path Parameters
redirectURI
required
string
query Parameters
state
required
string
session_state
required
string
code
required
string

Responses

validateAdminToken

Responses

collections-controller

Get testcases for collection

Get testcases for collection by id

path Parameters
id
required
string

Responses

Get partner testcases for collection

Get partner testcases for collection by id and partner id

path Parameters
partnerId
required
string
id
required
string

Responses

Get collections

Get collections based on the project id and project type

query Parameters
projectId
required
string
type
required
string

Responses

Get collection

Get collection by id

path Parameters
id
required
string

Responses

Add testcases for collection

Add selected testcases for collection

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
Array of objects (CollectionTestCaseDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": [
    ]
}

Add collection

Add new collection

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CollectionRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

biometric-testdata-controller

Get sample bio testdata file

Download sample bio testdata file according to the purpose

query Parameters
purpose
required
string

Responses

Get list of biometric testdata

Get list of biometric testdata uploaded by partners

Responses

Get biometric testdata file

Get biometric testdata file by id

path Parameters
id
required
string

Responses

Get bio testdata names

Get bio testdata names based on the purpose

query Parameters
purpose
required
string

Responses

Add biometric testdata

Partners can upload their own biometric testdata.

Request Body schema:
file
required
string <binary>
biometricMetaData
required
string

Responses

Request samples

Content type
No sample

projects-controller

Get projects

Get partner's projects

query Parameters
type
string

Responses

main-controller

Get config

Get configuration values

Responses