• Endpoints
  • SecurityCode
    • postCreates a new security code
    • getGets security code data for a validation code
    • postPerfom field validation for a validation code per position
    • postPerfom field validation for a validation code per label
    • postPerform validation for a validation code and each values of field
  • Watermark
    • putAdd the watermark to a pdf

API docs by Redocly

eAuth API (v9.1)

Download OpenAPI specification:Download

Artionet: support@artionet.com URL: https://www.artionet.ch/

Welcome to the eAuth API documentation.

You can try out the API using Swagger.

You can find a detailed documentation by following this link.

SecurityCode

Creates a new security code

Request Body schema:

application/jsonapplication/xmlapplication/json

A NewSecurityCode object for which the validation code is generated

type required	string [ 0 .. 100 ] characters The type of document
issuer required	string [ 0 .. 255 ] characters The document issuer
clientFullName required	string [ 0 .. 100 ] characters The security code user name
	Array of objects or null (NewSecurityCodeField) The list of security code field

Responses

https://api.egov4.ch/eauth/demo/v9-1/securitycode

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "type": "string",
• "issuer": "string",
• "clientFullName": "string",
• "securityCodeFields": [

  • {

    • "label": "string",
    • "value": "string",
    • "format": "string",
    • "type": "string",
    • "position": 0

    }

  ]

}

Response samples

• 201
• 400

Content type

application/jsonapplication/xmlapplication/json

"string"

Gets security code data for a validation code

path Parameters

validationCode required

string The validation

Responses

https://api.egov4.ch/eauth/demo/v9-1/securitycode/{validationCode}

Response samples

• 200

Content type

application/jsonapplication/xmlapplication/json

{

• "validationCode": "string",
• "type": "string",
• "issuer": "string",
• "clientFullName": "string",
• "securityCodeFields": [

  • {

    • "label": "string",
    • "format": "string",
    • "type": "string",
    • "position": 0

    }

  ]

}

Perfom field validation for a validation code per position

path Parameters

validationCode required	string The validation code
position required	integer <int32> The field position

query Parameters

value required

string The user input value to validate

Responses

https://api.egov4.ch/eauth/demo/v9-1/securitycode/{validationCode}/field/{position}/validation

Response samples

• 200

Content type

application/jsonapplication/xmlapplication/json

true

Perfom field validation for a validation code per label

path Parameters

validationCode required

string The validation code

query Parameters

label required	string The field label
value required	string The user input value to validate

Responses

https://api.egov4.ch/eauth/demo/v9-1/securitycode/{validationCode}/field/validation

Response samples

• 200

Content type

application/jsonapplication/xmlapplication/json

true

Perform validation for a validation code and each values of field

Request Body schema:

application/jsonapplication/xmlapplication/json

A ValidateValues object containing values to validate

validationCode required	string The validation code
required	Array of objects (ValidateValue) The list a values to validate

Responses

https://api.egov4.ch/eauth/demo/v9-1/securitycode/validation

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "validationCode": "string",
• "values": [

  • {

    • "label": "string",
    • "position": 0,
    • "value": "string"

    }

  ]

}

Response samples

• 200
• 400

Content type

application/jsonapplication/xmlapplication/json

{

• "result": true,
• "responses": [

  • {

    • "result": true,
    • "label": "string",
    • "position": 0,
    • "value": "string"

    }

  ]

}

Watermark

Add the watermark to a pdf

path Parameters

validationCode required

string The validation code

query Parameters

ValidationCodeLabel required	string The QR code label
Angle	number <float> (optional) The watermark angle. 55 by default
TranslationX	number <float> (optional) The watermark translation on x. 50 by default
TranslationY	number <float> (optional) The watermark translation on y. 50 by default
ScaleX	number <float> (optional) The document x scale. 1 by default
ScaleY	number <float> (optional) The document y scale. 1 by default
QRCodeX	number <float> (optional) The QR code position on X. 0 by default
QRCodeY	number <float> (optional) The QR code position on Y. 0 by default
QRCodeSize	number <float> (optional) The QR code size. 60 by default
ValidationCodeLabelX	number <float> (optional) The QR code labels position on X. QRCodeX + QRCodeSize by defaulf
ValidationCodeLabelY	number <float> (optional) The validation code label position on Y. 45 by default
CodeLabelY	number <float> (optional) The code label position on Y. 25 by default
QRCodeData	string (optional) The data to encrypt in the QR code. Validation code by default
Encrypt	boolean (optional) A value indicating whether to encrypt this eAuth.Api.Services.Models.WatermarkRequest. True by default
CodePageDisposition	integer <int32> Enum: 0 1 2 (optional) Where the code appears. 0: all pages, 1: first page, 2: first and last pages. All pages per default.

Request Body schema: multipart/form-data

file required

string <binary> The pdf to watermark

Responses

https://api.egov4.ch/eauth/demo/v9-1/watermark/{validationCode}

Response samples

• 400

Content type

application/jsonapplication/xmlapplication/json

{

• "errors": {

  • "property1": [

    • "string"

    ],
  • "property2": [

    • "string"

    ]

  },
• "type": "string",
• "title": "string",
• "status": 0,
• "detail": "string",
• "correlationId": "string",
• "property1": null,
• "property2": null

}