Authentication

Completes a certificate authentication

post/api/v2/authentication/completion

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/authentication/completion
  • Auth: none declared

Request body

statestring required
certificatestring byte required
signaturestring byte required

Example request

{
  "signature": "signature",
  "certificate": "certificate",
  "state": "state"
}

Response

Success

successboolean
failure'CertificateFailedValidation' | 'StaleSession'

Example response

{
  "validationResults": {
    "passedChecks": [
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      },
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      }
    ],
    "warnings": [
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      },
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      }
    ],
    "errors": [
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      },
      {
        "detail": "detail",
        "type": "Success",
        "message": "message",
        "innerValidationResults": null
      }
    ]
  },
  "success": true,
  "failure": "CertificateFailedValidation",
  "certificate": {
    "serialNumber": "serialNumber",
    "issuerName": {
      "country": "country",
      "commonName": "commonName",
      "serialNumber": "serialNumber",
      "initials": "initials",
      "dnString": "dnString",
      "givenName": "givenName",
      "locality": "locality",
      "organizationUnit": "organizationUnit",
      "title": "title",
      "pseudonym": "pseudonym",
      "emailAddress": "emailAddress",
      "dnQualifier": "dnQualifier",
      "stateName": "stateName",
      "surname": "surname",
      "organization": "organization",
      "generationQualifier": "generationQualifier",
      "allValues": {
        "key": [
          "allValues",
          "allValues"
        ]
      }
    },
    "validityEnd": "2000-01-23T04:56:07.000+00:00",
    "thumbprint": "thumbprint",
    "pkiBrazil": {
      "rgEmissor": "rgEmissor",
      "oabNumero": "oabNumero",
      "rgNumero": "rgNumero",
      "companyName": "companyName",
      "cpf": "cpf",
      "oabUF": "oabUF",
      "dateOfBirth": "dateOfBirth",
      "rgEmissorUF": "rgEmissorUF",
      "cnpj": "cnpj",
      "responsavel": "responsavel",
      "certificateType": "Unknown"
    },
    "validityStart": "2000-01-23T04:56:07.000+00:00",
    "issuer": null,
    "binaryThumbprintSHA256": "binaryThumbprintSHA256",
    "emailAddress": "emailAddress",
    "pkiItaly": {
      "idCarta": "idCarta",
      "codiceFiscale": "codiceFiscale",
      "certificateType": "Undefined"
    },
    "organizationIdentifier": "organizationIdentifier",
    "issuerDisplayName": "issuerDisplayName",
    "organization": "organization",
    "subjectIdentifier": "subjectIdentifier",
    "subjectCommonName": "subjectCommonName",
    "thumbprintSHA256": "thumbprintSHA256",
    "subjectDisplayName": "subjectDisplayName",
    "subjectName": {
      "country": "country",
      "commonName": "commonName",
      "serialNumber": "serialNumber",
      "initials": "initials",
      "dnString": "dnString",
      "givenName": "givenName",
      "locality": "locality",
      "organizationUnit": "organizationUnit",
      "title": "title",
      "pseudonym": "pseudonym",
      "emailAddress": "emailAddress",
      "dnQualifier": "dnQualifier",
      "stateName": "stateName",
      "surname": "surname",
      "organization": "organization",
      "generationQualifier": "generationQualifier",
      "allValues": {
        "key": [
          "allValues",
          "allValues"
        ]
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.