You are viewing the documentation for a prerelease version.

Validator API

GetVersion

This method will return the current version of the validator module. This can be used as a ping method. This call is non-encrypted.

SOAP content type

text/xml; charset="utf-8";

SOAP header

Action:

"http://www.pointsharp.com/netid/server/validator/IServiceSoap/GetVersion"

SOAP body

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetVersion xmlns="http://www.pointsharp.com/netid/server/validator">
    </GetVersion>
  </s:Body>
</s:Envelope>

SOAP response

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetVersionResponse xmlns="http://www.pointsharp.com/netid/server/validator">
      <GetVersionResult>
        <Version>6.0.0.10</Version>
        <Status>
          <Code>Success</Code>
          <Description>Success</Description>
        </Status>
      </GetVersionResult>
    </GetVersionResponse>
  </s:Body>
</s:Envelope>

REST content type

application/json; charset="utf-8";

REST method type:

GET

REST URI template

/api/version/get

REST request

No data is needed. This is a GET method.

REST response

{
  "Version": "6.0.0.10",
  "Status": {
    "Code": "Success",
    "Description": "Success"
  }
}

Validate

This method will validate a certificate or signature. This call is non-encrypted.

Input-Data

The certificate or signature as PEM-encoded base64-string. The certificate must be an X509 certificate. The signature must be a CMC/PKCS#7 blob with attached X509 certificate.

SOAP content type

text/xml; charset="utf-8";

SOAP header

Action: "http://www.pointsharp.com/netid/server/validator/IServiceSoap/Validate"

SOAP body

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetObject xmlns="http://www.pointsharp.com/netid/server/validator">
      <Info>
        <Data>-----BEGIN CERTIFICATE-----MII...-----END CERTIFICATE </Data>
      </Info>
    </GetObject>
  </s:Body>
</s:Envelope>

SOAP response

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <ValidateResponse xmlns="http://www.pointsharp.com/netid/server/validator">
      <ValidateResult>
        <ValidateInfo>
          <Type>OCSP</Type>
          <Info>MII. </Info>
        </ValidateInfo>
        <Status>
          <Code>Success</Code>
          <Description>Success</Description>
        </Status>
      </ValidateResult>
    </ValidateResponse>
  </s:Body>
</s:Envelope>

REST content type

application/json; charset="utf-8";

REST method type

POST

REST URI template

/api/validate

REST request

{
  "Data": "-----BEGIN CERTIFICATE-----MII...-----END CERTIFICATE "
}

REST response

{
  "ValidateInfo": {
    "Type": "OCSP",
    "Info": "MII..."
  },
  "Status": {
    "Code": "Success",
    "Description": "Success"
  }
}

Output

The response will contain the entire object typed in the request.

Output-ValidateInfo

The validation information object.

Output-ValidateInfo-Type

The validation of type of CDP / AIA informatio of current certificate and should be either CRL or OCSP.

Output-ValidateInfo-Info

The additional information of the validation. The OCSP response as base64 encoded string (e.g. MII…), or the last modified CRL (e.g. 2023-11-02 12:32:11).

Output-Status

The generic status object.

Output-Status-Code

The generic status code. This should be "Success" for a correct validation of the certificate or signature, otherwise an error code will be shown.

Table 1. Available error code and their descriptions
Error code	Description
NPR_DATA_MISSING	The input data is missing.
NPR_DATA_INVALID	The input data is invalid (e.g., not base64 encoded, etc.).
NPR_CERTIFICATE_EXPIRED	The certificate has expired.
NPR_CERTIFICATE_REVOKED	The certificate is revoked.
NPR_CERTIFICATE_NOT_APPROVED	The certificate could not be approved against customized configuration.
NPR_CERTIFICATE_CDP_AIA_MISSING	The CDP and AIA extension is missing in the certificate.
NPR_SIGNATURE_FAILED	The signature could not be verified.

Output-Status-Description

The additional information description of the status.