Skip to main content

ResumeMessageInsert

This article explains how to attach a summary to the message flow via the Unico Check REST API.

How to use it?​

Make a POST request to the /messages/{processoId}/resume endpoint​

With a valid Access token, make a request to the endpoint (POST/messages/{processoId}/resume) sending the following parameters:

{
  "resumes": [
    {
      "description": "DESCRICAO_RESUMO",
      "html": "HTML_RESUMO"
    },
  ]
}

Parameters:

  • PATH PARAMETERS
NameTypeMandatory/OptionalDescription
processoIdStringMandatoryProcess number
  • HEADER PARAMETERS
NameTypeMandatory/OptionalDescription
APIKEYStringMandatoryAPI key
AuthorizationStringMandatoryAccess token
Content-TypeStringMandatory"application/json"
  • REQUEST BODY SCHEMA
NameTypeMandatory/OptionalDescription
resumes.descriptionStringMandatoryIndica a descrição do resumo
resumes.htmlStringMandatoryIndica o HTML do resumo

Request example:

{
  "resumes": [
    {
      "description": "Resumo 1",
      "html": "<html> <body> <p> Resumo </p> </body> </html>"
    },
    {
      "description": "Resumo 2",
      "html": "<html> <body> <p> Resumo </p> </body> </html>"
    }
  ]
}

If the request was executed successfully, the return response is a JSON containing the ID of the process created by sending the photo as follows:

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481"
}

If an error occurs, the return response is a JSON containing the error code and description:

{
    "Error": {
        "code": "40004",
        "description": "Error description"
    }
}

For more information on the errors returned, see the list available in the article Response Errors.

Any concerns?​

Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.