GDPR Script documentation

The endpoint to generate a consent

There needs to be a POST API call to be able to create the audit trail certifying the information registered from any form where the GDPR script is installed and identified with a valid form Id and origin domain.

                                                                                                                                           

Method: POST

Path: https://gdpr-api.signaturit.com/v1/forms/{formId}/consents

Body: body request content:

Screen_Shot_2018-08-20_at_17.31.35.png

Results:

Success:

Screen_Shot_2018-08-20_at_17.32.33.png

Error:

Screen_Shot_2018-08-20_at_17.32.37.png

 

The endpoint to retrieve the consents

In order to query consents for any fields you have set, you will need to do a GET API call. For that, you will need to use your token.

This GET API call needs to be multivalue so that you can search for multiple fields in one form using query parameters. This GET API call should also provide the Audit Trail IDs that you need to download them.

                                                                                                                                           

Method: GET

Path:

/forms/{formId}/consents/?formInput=value&offset=2&limit=10

Options:

  • offset: first element that you want to receive. If you put 4, you will receive the 4th element and the next ones.
  • limit: maximum number of consents that the endpoint will return. Maximum 100.
  • formInput: name of a specific field in your form.

Results:

Success:

Screen_Shot_2018-08-20_at_17.37.10.png

Error:

Screen_Shot_2018-08-20_at_17.37.16.png

 

The endpoint to download an audit trail

You will need to do a GET call in order to download a specific audit trail. For this, you will need the ID of the specific form and the ID of the audit trail created at the moment of submitting the information into the system.

                                                                                                                                           

 

Method: GET

Path: /forms/{formId}/consents/{consentId}/download

Results:

Success:

It downloads a PDF.

Error:

Screen_Shot_2018-08-20_at_17.41.29.png

  

 

The endpoint to get a form

You can perform this GET call in order to get a specific form. You will need the form ID.

                                                                                                                                           

Method: GET

Path: /forms/{formId}

Results:

Success:

Screen_Shot_2018-08-20_at_17.42.55.png

Error:

Screen_Shot_2018-08-20_at_17.43.00.png

 

The endpoint to replace the form domains 

You can use this to replace the current domains for the new ones specified. Please note that this will not add domains, it will replace them.

                                                                                                                                           

Method: GET

Path: /forms/{formId}

Body:

Screen_Shot_2018-08-20_at_17.44.28.png

Results:

Success:

Screen_Shot_2018-08-20_at_17.44.33.png

Error:

Screen_Shot_2018-08-20_at_17.44.38.png

 

 

 

 

 

 

¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.
Tecnología de Zendesk