Page History

Request Method >>  PUT

Request URL         >>  https://verifid.ecertia.com/api/v1/Enrollments

Authentication >> This API requires via an API key. They key must be included in the request header. 

Request Headers

Request Body

List of Parameters

Request Response

List of parameters

...

• LegalName: Name or corporate name of the recipient of the email (for example, The name and Fiscal Identity Number (NIF) of the recipient company).
• PhoneNumber: Message recipient’s mobile phone number.

...

• None: None – Only tracking of status, alerts and traceability.
• Standard: Standard – Generation of an affidavit (receipt) when the tracking of status is over.
• Advanced: Advanced – several affidavits (one for each event) and timestamp. This is the default value. This parameter is important for invoicing purposes.

...

• Submitted: An Affidavit will be generated when the message has been processed locally, its contents certified and ready for further transmission.
• SubmittedAdvanced: An Affidavit will be generated when the message was processed locally, its contents certified and included in the Affidavit, ready for further transmission.
• TransmissionResult: An Affidavit will be generated when:
  • The system successfully sent the message to the server of the organisation managing the recipient's phone number.
  • The system could not credit the sending of the message to the server of the organisation managing the recipient's phone number.
• DeliveryResult: An Affidavit will be generated when:
  • The system received confirmation of the delivery of the message.
  • The system received confirmation that the message was undeliverable.
• Read: An Affidavit will be generated when the system confirmed the opening/reading of the message.
• Closed: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached.
• ClosedAdvanced: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached. The content will be included in the Affidavit.
• Complete: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached and generated a tracking summary.
• CompleteAdvanced: An Affidavit will be generated when the system terminated the processing of the message when the tracking expiry date was reached and generated a tracking summary. The content will be included in the Affidavit.
• Event: An Affidavit will be generated when the system received an event considered relevant that does not have a specific Kind of affidavit.

...

• None: None affidavit will be generated.
• Basic: Generation of an affidavit (receipt) when the tracking of status is over. This is the default value in case of selecting Standard in CertificationLevel.
• AdvancedContentOnSubmit: Several affidavits (one for each event) and timestamp. The content certification affidavit will show the body of the message flagged as IncludeOnAffidavits. This is the default value in case of selecting Advanced in CertificationLevel.
• AdvancedContentOnClose: Several affidavits (one for each event) and timestamp. Generation of an affidavit (receipt) when the tracking of status is over. The affidavit receipt will show the body of the message flagged as IncludeOnAffidavits.
• AdvancedContentOnSubmitAndOnClose: Several affidavits (one for each event) and timestamp. The content certification affidavit and the affidavit receipt will show the body of the message flagged as IncludeOnAffidavits. Moreover, it will generate an affidavit (receipt) when the tracking of status is over.

...

• Number of minutes.

...

• True o 1: No logos to be displayed.
• False o 0: Some logos are displayed.

...

• en (Default)
• es
• ca
• it
• pt
• fr
• de
• ro

...

• en (Default)
• es
• ca
• it
• pt
• ro

...

• AutoChallenge: Request of random known data, the operation will be carried out if a random question about a known data, such as the e-mail address of the recipient, is answered correctly.
• Challenge: Challenge question/answer, the operation will be carried out if the question selected as challenge by the issuer to be answered correctly.
• Public: Registered user, authentication by local registered user user/password.
• Session: Users of related sites (issuer/recipient).
• Other values ​​that should only be reported if the corresponding method has been selected are as follows:
  • EvidenceAccessControlChallenge: If option Challenge has been selected as EvidenceAccessControlMethod this is where you specify the question.
  • EvidenceAccessControlChallengeResponse: If Challenge has been selected as EvidenceAccessControlMethod this is where you specify the answer to the question raised in EvidenceAccessControlChallenge.

...

• Forward: Default option, content of the SMS is delivered directly to the recipient. This type of sending is an EviSMS or certified SMS.
• Notify ( Deprecated ): The recipient will receive a link instead of the content, and in order to view the content, he/she must click that link. With this type of sending you can attach any type of content to the SMS.This type of sending is an EviNotice to mobile phone.
  • Sendings of EviNotice to mobile phone allow to send the attachments with the contents.

...

• Challenge: Challenge question/answer. The operation will be carried out if the question selected as challenge by the issuer to be answered correctly.
• WebClick: Click in web through safe link or locator. The operation will be carried out if the reference or locator of the message is known.
• MobilePin: Security code PIN sent to mobile phone. The operation will be carried out after identifying the user that accesses or signs, requesting a random PIN sent to his mobile phone.
  • WhatsAppPinPolicy: Indicates the default value for the PIN sending policy by WhatsApp. It only applies when the signature method is MobilePin.
    • Disabled: The WhatsApp channel is not enabled to send the PIN. Corresponds to the Normal delivery policy (by SMS).
    • Optional: The WhatsApp channel is enabled to send the PIN as an alternative to SMS.
    • Fallback: The WhatsApp channel is enabled to send the PIN only on retry.
• EmailPin: Security code PIN sent to e-mail. The operation will be carried out after identifying the user that accesses or signs, requesting a random PIN sent to his e-mail address.
• Other values ​​that should only be reported if the corresponding method has been selected are as follows:
  • DeliverySignChallenge: Question asked when the signature method is Challenge.
  • DeliverySignChallengeResponse: Answer to the previous question.
  • DeliverySignFixedEmail: Email account to send the PIN to when the chosen method is EmailPin.
  • DeliverySignFixedMobile: Mobile phone number to send the PIN to when the signing method is MobilePin.

...

• True: The recipient is given the option to refuse to view the content of a notification.
• False: The recipient has no option to decline.

...

• Disabled, there is no button in EviSms.
• Accept, text "Accept" appears in EviSms and check "Accept" appears on the agreement page.
• Reject, text "Reject" appears in EviSms and check "Reject" appears on the agreement page.
• AcceptOrReject, text "Accept/Reject" appears in EviMail and checks "Accept" and "Reject" appear on the agreement page.

...

• True: Comments are allowed. This is the default value, but "CommitmentOptions" must be different from "Disabled"
• False: Comments are not allowed.

...

• Ready: The message has been locally processed. It will be subsequently sent.
• Sent: The message has been sent to the server or the operator that manages the mailbox or device of recipient: from now on the system will manage the process of reception.
• Dispatched: The messaging service serving the recipient has accepted of the message and will then try to send it to the final recipient.
• Delivered: The message has been delivered to the final recipient, but the content still has not been opened/read.
• Read: The message has been opened/read by the final recipient.
• Replied: The recipient has answered accepting or rejecting the message.
• Failed: The message has failed to be delivered to the recipient for any reason. This is not a final state.
• Closed: End of the tracking of status, for which reason no more notifications or answers are expected and the notarial deposit will follow.

...

• Key: Name of the key.
• Value: Value for the previous key.

...

• Key = IncludeOnAffidavits, Value = true, indicates that the annex will be included in the affidavits.

...

 [
	{
		"UniqueId":"00000000-0000-0000-0000-000000000000",
		"CreationDate":"0001-01-01T00:00:00",
		"EvidenceUniqueId":"00000000-0000-0000-0000-000000000000",
		"DisplayName":"4kb.pdf",
		"Filename":"4kb.pdf",
		"Data":"[ATTENTION: here would be the BASE64 of the attachment in PDF format.]",
		"Attributes": [
			{
				"Key":"IncludeOnAffidavits",
				"Value":true
			}
		]
	}
]

...

POST https://app.ecertia.com/api/EviSms/Submit HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.ecertia.com

{
	"LookupKey":"Evi",
	"Text":"Hi This is a certified SMS",
	"IssuerName":"JGM",
	"Recipient":
	{
		"LegalName":"Juan Gallego",
		"PhoneNumber":"+34xxxxx"
	}
	"Options":
	{
		"CertificationLevel":"Advanced",
		"TimeToLive":10500
	}
}

POST https://app.ecertia.com/api/EviSms/Submit HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.ecertia.com
{
	"lookupKey": "xxx",
	"subject":"xxx",
	"text": "xxx",
	"issuerName": "xx",
	"recipient":{
		"LegalName":"Juan Gallego",
		"PhoneNumber":"+34xxxxx"
	},
	"Options":{
		"DeliveryMode":"Notify",
		"CommitmentOptions": "Disabled",
		"CertificationLevel":"Advanced",
	},
	"Attachments": {
		"DisplayName": "xxx",
		"Filename": "xxxx",
		"MimeType": "application/pdf",
		"Data": "pdf en base 64"
	}
}

In case of successful sending, the identifier allocated to the evidence (Evild) that can be used later to consult its state is returned.

{
	"EviId":"dd24e27d-2d84-4f74-a7f0-a23b018ab798"
}

Idempotence Activation

There is the option to activate the idempotency capability to avoid sending the same EviSMS more than once in case of repeated submitting. For that, a request with the name "X-Evi-IdempotencyToken" must be added to the request headers, adding as a value some random text (the use of a GUID is recommended).

Examples and further information about parameters

More information is given below and examples of the parameters are given, so that they are understood more easily. This section is organized in alphabetical order.

Push notifications

...

• Identifier: Identifier of the event.
• Kind:  Mnemonic of the notification received.
• Date: Date of event.
• EvidenceId: Identifier of evidence.
• EvidenceType: Type of evidence.
• Site: Name of user’s site.
• Owner: Name of site’s user.
• OwnerEmail: Email of site’s user.
• AdditionalData: Additional information in the form of a key-value.
  • Source: Name of the issuer.
  • Destination: Name of the recipient.
  • Subject: Subject indicated by the issuer.
  • LookupKey: Identifier allocated by the user, it can be used later to locate evidence through the query web service (Query).
  • State: Name of the evidence state.
  • CreationDate: Creation date.

...

• Sent:
  • XmissionDetails: Technical detail of delivery process.
• Dispatched/Delivered/Read:
  • Progress: Title of the progress.
  • Description: Detailed description of the progress.
• Replied:
  • Kind: Action carried out by the signatory user.
  • Comments: Comments made by the signatory user.
• Closed:
  • Outcome: Result of processing.

...