Home
Documentation Powered by ReDoc

Id Authentication Internal Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Id Authentication Internal Service

Authentication

Authorization

Security Scheme Type API Key
Header parameter name: Authorization

internal-update-auth-type-controller

Internal Update Auth Type Controller

updateAuthtypeStatus

updateAuthtypeStatus

path Parameters
partnerId
required
string
Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

signaturecontroller

Operation related to signature

Function to validate signature Deprecated

Function to validate signature

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

Responses

Request samples

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

Function to sign response Deprecated

Function to sign response

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

Responses

Request samples

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

Function to sign PDF

Function to sign PDF

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

Responses

Request samples

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

Function to JWT Signature verification

Function to JWT Signature verification

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

Responses

Request samples

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

TFunction to JWT sign datas

Function to JWT sign data

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

Responses

Request samples

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

Function to do JSON Web Signature(JWS) for the inputted data using inputted algorithm. Default Algorithm PS256.

Function to JWT sign data

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

Responses

Request samples

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

cryptomanager

Operation related to Encryption and Decryption

Encrypt the data

Encrypt the data

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

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": [
    ]
}

Encrypt the data with pin

Encrypt the data with pin

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

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": [
    ]
}

Encrypt the data & encrypt hash of the data with same session key

Encrypt the data & encrypt hash of the data with same session key

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

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": [
    ]
}

Decrypt the data

Decrypt the data

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

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": [
    ]
}

Decrypt the data with pin

Decrypt the data with pin

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

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": [
    ]
}

Decrypt the data & encrypt hash of the data with same session key

Decrypt the data & encrypt hash of the data with same session key

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

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": [
    ]
}

master-data-update-event-controller

Master Data Update Event Controller

handleMasterdataTitlesUpdate

handleMasterdataTitlesUpdate

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handleMasterdataTemplatesUpdate

handleMasterdataTemplatesUpdate

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

partner-ca-cert-event-controller

Partner CA Cert Event Controller

handleCACertificate

handleCACertificate

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

partnercertmanager

Operation related to partner certificate management

To Upload Partner Certificate

To Upload Partner Certificate

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

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": [
    ]
}

To Upload Partner Certificate

To Upload Partner Certificate

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

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": [
    ]
}

To Upload CA/Sub-CA certificates

To Upload CA/Sub-CA certificates

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

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": [
    ]
}

To Download Partner Certificate

To Download Partner Certificate

path Parameters
partnerCertId
required
string

Responses

credential-issueance-callback-controller

Credential Issueance Callback Controller

Event Notification Callback API

Event Notification Callback API

path Parameters
partnerId
required
string
Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Event Notification Callback API

Event Notification Callback API

path Parameters
partnerId
required
string
Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Event Notification Callback API

Event Notification Callback API

path Parameters
partnerId
required
string
Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Event Notification Callback API

Event Notification Callback API

path Parameters
partnerId
required
string
Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

internal-auth-txn-controller

Internal Auth Txn Controller

Auth Transaction Request

Auth Transaction Request

path Parameters
ID
required
string
query Parameters
IDType
string
pageStart
integer <int32>
pageFetch
integer <int32>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

hotlist-event-controller

Hotlist Event Controller

handleHotlisting

handleHotlisting

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

partner-service-callback-controller

Partner Service Callback Controller

handlePolicyUpdated

handlePolicyUpdated

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handlePartnerApiKeyUpdated

handlePartnerApiKeyUpdated

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handlePartnerApiKeyUpdated

handlePartnerApiKeyUpdated

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handleMispUpdatedEvent

handleMispUpdatedEvent

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handleMispLicenseGeneratedEvent

handleMispLicenseGeneratedEvent

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

handleApiKeyApprovedEvent

handleApiKeyApprovedEvent

Request Body schema: application/json
publisher
string
topic
string
publishedOn
̥ "string"
object (Event)

Responses

Request samples

Content type
application/json
{
  • "publisher": "string",
  • "topic": "string",
  • "publishedOn": null,
  • "event": {
    }
}

keymanager

Operation related to Keymanagement

Update signed certificate for the provided APP ID & REF ID for other domains

Update signed certificate for the provided APP ID & REF ID for other domains

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

Responses

Request samples

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

Update signed certificate for the provided APP ID & REF ID

Update signed certificate for the provided APP ID & REF ID

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

Responses

Request samples

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

Request to Revoke Base Key for the provided APP ID & REF ID

Request to Revoke Base Key for the provided APP ID & REF ID

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

Responses

Request samples

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

Request to get Certificate for the Provided APP ID & REF ID

Request to get Certificate for the Provided APP ID & REF ID

query Parameters
applicationId
required
string
referenceId
string

Responses

Request to Generate Symmetric key for the provided APP ID & REF ID

Request to Generate Symmetric key for the provided APP ID & REF ID

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

Responses

Request samples

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

Generate Master Key for the provided APP ID

Generate Master Key for the provided APP ID

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

Responses

Request samples

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

Request to Generate CSR for the provided APP ID & REF ID along with other certificate params

Request to Generate CSR for the provided APP ID & REF ID along with other certificate params

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

Responses

Request samples

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

internal-auth-controller

Internal Auth Controller

Authenticate Internal Request

Authenticate Internal Request

Authorizations:
Authorization
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

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": {
    },
  • "consentObtained": true,
  • "requestHMAC": "string",
  • "requestSessionKey": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Authenticate Internal Request

Authenticate Internal Request

Authorizations:
Authorization
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

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": {
    },
  • "consentObtained": true,
  • "requestHMAC": "string",
  • "requestSessionKey": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

internal-otp-controller

Internal OTP Controller

generateOTP

generateOTP

Authorizations:
Authorization
Request Body schema: application/json
id
string
version
string
individualId
string
individualIdType
string
transactionID
string
requestTime
string
otpChannel
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "individualId": "string",
  • "individualIdType": "string",
  • "transactionID": "string",
  • "requestTime": "string",
  • "otpChannel": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "transactionID": "string",
  • "responseTime": "string",
  • "errors": [
    ],
  • "response": {
    }
}
Home