ImzagerServices

<back to all web services

Verification

The following routes are available for this service:
All Verbs/Verification/{ClientKey}
"use strict";
export class VerifyDocumentDetails {
    /** @param {{DocumentContent?:string,DocumentName?:string,DocumentType?:string,DocumentKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentContent;
    /** @type {string} */
    DocumentName;
    /** @type {string} */
    DocumentType;
    /** @type {string} */
    DocumentKey;
}
export class TSValidationResultItem {
    /** @param {{ID?:string,Message?:string,Result?:string,Successed?:boolean,Child?:TSValidationResultItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Message;
    /** @type {string} */
    Result;
    /** @type {boolean} */
    Successed;
    /** @type {TSValidationResultItem[]} */
    Child;
}
export class SgValidationResultItem {
    /** @param {{ID?:string,Message?:string,Result?:string,Successed?:boolean,Child?:SgValidationResultItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Message;
    /** @type {string} */
    Result;
    /** @type {boolean} */
    Successed;
    /** @type {SgValidationResultItem} */
    Child;
}
export class CertValidationResultItem {
    /** @param {{ID?:string,Message?:string,Result?:string,Successed?:boolean,Child?:CertValidationResultItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Message;
    /** @type {string} */
    Result;
    /** @type {boolean} */
    Successed;
    /** @type {CertValidationResultItem} */
    Child;
}
export class VerifySignerDetails {
    /** @param {{Cert_SubjectCN?:string,ID?:string,SignerCertificate?:X509Certificate2,SignType?:string,SignAlgorithm?:string,HashAlgorithm?:string,SignStatusIsValid?:boolean,CertStatusValue?:string,SigningTime?:string,IsTimeStampExist?:boolean,NextSigner?:VerifySignerDetails,CounterSigners?:VerifySignerDetails[],TimeStampDetails?:TSValidationResultItem[],SignValidationDetails?:SgValidationResultItem[],CertValidationDetails?:CertValidationResultItem[],Cert_SubjectSN?:string,Cert_Issuer?:string,Cert_ValidFrom?:string,Cert_ValidTo?:string,CertBase64?:string,SigningLocation?:string,SigningReason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Cert_SubjectCN;
    /** @type {string} */
    ID;
    /** @type {X509Certificate2} */
    SignerCertificate;
    /** @type {string} */
    SignType;
    /** @type {string} */
    SignAlgorithm;
    /** @type {string} */
    HashAlgorithm;
    /** @type {boolean} */
    SignStatusIsValid;
    /** @type {string} */
    CertStatusValue;
    /** @type {string} */
    SigningTime;
    /** @type {boolean} */
    IsTimeStampExist;
    /** @type {VerifySignerDetails} */
    NextSigner;
    /** @type {VerifySignerDetails[]} */
    CounterSigners;
    /** @type {TSValidationResultItem[]} */
    TimeStampDetails;
    /** @type {SgValidationResultItem[]} */
    SignValidationDetails;
    /** @type {CertValidationResultItem[]} */
    CertValidationDetails;
    /** @type {string} */
    Cert_SubjectSN;
    /** @type {string} */
    Cert_Issuer;
    /** @type {string} */
    Cert_ValidFrom;
    /** @type {string} */
    Cert_ValidTo;
    /** @type {string} */
    CertBase64;
    /** @type {string} */
    SigningLocation;
    /** @type {string} */
    SigningReason;
}
export class VerifyResult {
    /** @param {{Result?:boolean,ErrorMesage?:string,IsValid?:boolean,DocumentDetails?:VerifyDocumentDetails[],Signers?:VerifySignerDetails[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Result;
    /** @type {string} */
    ErrorMesage;
    /** @type {boolean} */
    IsValid;
    /** @type {VerifyDocumentDetails[]} */
    DocumentDetails;
    /** @type {VerifySignerDetails[]} */
    Signers;
}
export class VerificationResponse {
    /** @param {{Result?:VerifyResult,ServiceSuccessResult?:boolean,ErrorMesage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VerifyResult} */
    Result;
    /** @type {boolean} */
    ServiceSuccessResult;
    /** @type {string} */
    ErrorMesage;
}
export class Verification {
    /** @param {{ClientKey?:string,AuthorizationID?:string,DocumentId?:number,UserSSN?:string,Mode?:string,IsContentInclude?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ClientKey;
    /** @type {string} */
    AuthorizationID;
    /** @type {number} */
    DocumentId;
    /** @type {string} */
    UserSSN;
    /** @type {string} */
    Mode;
    /** @type {boolean} */
    IsContentInclude;
}

JavaScript Verification DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Verification/{ClientKey} HTTP/1.1 
Host: imzagerservices.eyyubiye.bel.tr 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ClientKey":"String","AuthorizationID":"String","DocumentId":0,"UserSSN":"String","Mode":"String","IsContentInclude":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'VerificationResponse' using the custom 'other' filter}One or more errors occurred.