Id Authentication Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Id Authentication Service

Authentication

Authorization

Security Scheme Type	API Key
Header parameter name:	Authorization

kyc-auth-controller

Kyc Auth Controller

eKyc Request

Authorizations:

Authorization

path Parameters

MISP-LK required	string
eKYC-Partner-ID required	string
API-Key required	string

header Parameters

signature

any

Request Body schema: application/json

id	string
version	string
individualId	string
individualIdType	string
transactionID	string
requestTime	string
specVersion	string
thumbprint	string
domainUri	string
env	string
	object (RequestDTO)
consentObtained	boolean
requestHMAC	string
requestSessionKey	string
	object
allowedKycAttributes	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"individualId": "string",
"individualIdType": "string",
"transactionID": "string",
"requestTime": "string",
"specVersion": "string",
"thumbprint": "string",
"domainUri": "string",
"env": "string",
"request": {"otp": "string",
"staticPin": "string",
"timestamp": "string",
"demographics": {"age": "string",
"dob": "string",
"name": [{"language": "string",
"value": "string"
}
],
"dobType": [{"language": "string",
"value": "string"
}
],
"gender": [{"language": "string",
"value": "string"
}
],
"phoneNumber": "string",
"emailId": "string",
"addressLine1": [{"language": "string",
"value": "string"
}
],
"addressLine2": [{"language": "string",
"value": "string"
}
],
"addressLine3": [{"language": "string",
"value": "string"
}
],
"location1": [{"language": "string",
"value": "string"
}
],
"location2": [{"language": "string",
"value": "string"
}
],
"location3": [{"language": "string",
"value": "string"
}
],
"postalCode": "string",
"fullAddress": [{"language": "string",
"value": "string"
}
],
"metadata": {"property1": { },
"property2": { }
}
},
"biometrics": [{"data": {"digitalId": {"serialNo": "string",
"make": "string",
"model": "string",
"type": "string",
"deviceSubType": "string",
"deviceProvider": "string",
"dp": "string",
"dpId": "string",
"deviceProviderId": "string",
"dateTime": "string"
},
"bioType": "string",
"bioSubType": "string",
"bioValue": "string",
"deviceCode": "string",
"deviceServiceVersion": "string",
"transactionId": "string",
"timestamp": "string",
"purpose": "string",
"env": "string",
"version": "string",
"domainUri": "string",
"requestedScore": 0,
"qualityScore": 0
},
"hash": "string",
"sessionKey": "string",
"specVersion": "string",
"thumbprint": "string"
}
]
},
"consentObtained": true,
"requestHMAC": "string",
"requestSessionKey": "string",
"metadata": {"property1": { },
"property2": { }
},
"allowedKycAttributes": ["string"
]
}

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
}
],
"metadata": {"property1": { },
"property2": { }
},
"actionMessage": "string",
"codes": ["string"
],
"errorText": "string",
"errorTexts": ["string"
],
"errorCode": "string",
"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"
}
]

master-data-update-event-controller

Master Data Update Event Controller

handleMasterdataTitlesUpdate

header Parameters

signature

any

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": { }
}
}
}

handleMasterdataTemplatesUpdate

header Parameters

signature

any

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": { }
}
}
}

partner-ca-cert-event-controller

Partner CA Cert Event Controller

handleCACertificate

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": { }
}
}
}

auth-controller

Auth Controller

Authenticate Request

Authorizations:

Authorization

path Parameters

MISP-LK required	string
Auth-Partner-ID required	string
API-Key required	string

header Parameters

signature

any

Request Body schema: application/json

id	string
version	string
individualId	string
individualIdType	string
transactionID	string
requestTime	string
specVersion	string
thumbprint	string
domainUri	string
env	string
	object (RequestDTO)
consentObtained	boolean
requestHMAC	string
requestSessionKey	string
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"individualId": "string",
"individualIdType": "string",
"transactionID": "string",
"requestTime": "string",
"specVersion": "string",
"thumbprint": "string",
"domainUri": "string",
"env": "string",
"request": {"otp": "string",
"staticPin": "string",
"timestamp": "string",
"demographics": {"age": "string",
"dob": "string",
"name": [{"language": "string",
"value": "string"
}
],
"dobType": [{"language": "string",
"value": "string"
}
],
"gender": [{"language": "string",
"value": "string"
}
],
"phoneNumber": "string",
"emailId": "string",
"addressLine1": [{"language": "string",
"value": "string"
}
],
"addressLine2": [{"language": "string",
"value": "string"
}
],
"addressLine3": [{"language": "string",
"value": "string"
}
],
"location1": [{"language": "string",
"value": "string"
}
],
"location2": [{"language": "string",
"value": "string"
}
],
"location3": [{"language": "string",
"value": "string"
}
],
"postalCode": "string",
"fullAddress": [{"language": "string",
"value": "string"
}
],
"metadata": {"property1": { },
"property2": { }
}
},
"biometrics": [{"data": {"digitalId": {"serialNo": "string",
"make": "string",
"model": "string",
"type": "string",
"deviceSubType": "string",
"deviceProvider": "string",
"dp": "string",
"dpId": "string",
"deviceProviderId": "string",
"dateTime": "string"
},
"bioType": "string",
"bioSubType": "string",
"bioValue": "string",
"deviceCode": "string",
"deviceServiceVersion": "string",
"transactionId": "string",
"timestamp": "string",
"purpose": "string",
"env": "string",
"version": "string",
"domainUri": "string",
"requestedScore": 0,
"qualityScore": 0
},
"hash": "string",
"sessionKey": "string",
"specVersion": "string",
"thumbprint": "string"
}
]
},
"consentObtained": true,
"requestHMAC": "string",
"requestSessionKey": "string",
"metadata": {"property1": { },
"property2": { }
}
}

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
}
],
"metadata": {"property1": { },
"property2": { }
},
"actionMessage": "string",
"codes": ["string"
],
"errorText": "string",
"errorTexts": ["string"
],
"errorCode": "string",
"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"
}
]

Home

Id Authentication Service (1.0)

Authentication

Authorization

kyc-auth-controller

eKyc Request

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

master-data-update-event-controller

handleMasterdataTitlesUpdate

header Parameters

Request Body schema: application/json

Responses

Request samples

handleMasterdataTemplatesUpdate

header Parameters

Request Body schema: application/json

Responses

Request samples

partner-ca-cert-event-controller

handleCACertificate

Request Body schema: application/json

Responses

Request samples

auth-controller

Authenticate Request

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Home