MultiAddress Parsing [application/json]

Request body description:

{
    "contents": []
}

Name	Type	Required	Description
contents	List of content object	Yes	Textual content previously extracted through one of the following mostQI services: - Content Extraction - Invoice Extraction - Multipage Content Extraction

Content

Name	Type	Required	Description
content	Object	Yes	Textual content contained within the `result` object, resulting from a previous extraction in other mostQI services, as described in the contents.

Request

Header Params

Authorization

string

required

Authorization token obtained from the Authentication/Authenticate method.

Example:

Bearer {{bearer_token}}

Param-Callback-Url

string

optional

Parametro para a chamada em assincrona. (ver exemplo de resposta)

Example:

https://callback-to-your-server

Param-AntiXss-Response

string

optional

Parametro para sanitizar o JSON da resposta

Example:

Body Params application/json

contents

array

required

Example

{
  "contents": []
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 OK Response - Example 1

application/json

Body

result

object

required

contents

array [object {2}]

required

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

message

string

required

code

string

required

errors

null

required

Example

{
  "result": {
    "contents": [
      {
        "index": 0,
        "extractions": [
          {
            "source": null,
            "sections": [
              {
                "name": null,
                "groups": [
                  {
                    "name": "endereco",
                    "stdValue": "RUA PARANA, 340\nBAIRRO CENTRO\nCEP 85501074\nPATO BRANCO - PR - BRASIL",
                    "score": 1,
                    "components": [
                      {
                        "name": "cep",
                        "stdName": "postcode",
                        "value": "85501-074",
                        "stdValue": "85501074",
                        "score": 1
                      },
                      {
                        "name": "pais",
                        "stdName": "country",
                        "value": null,
                        "stdValue": "REPUBLICA FEDERATIVA DO BRASIL",
                        "score": null
                      },
                      {
                        "name": "estado",
                        "stdName": "state",
                        "value": "PR",
                        "stdValue": "PARANA",
                        "score": 1
                      },
                      {
                        "name": "cidade",
                        "stdName": "city",
                        "value": "PATO BRANCO",
                        "stdValue": "PATO BRANCO",
                        "score": 1
                      },
                      {
                        "name": "bairro",
                        "stdName": "suburb",
                        "value": "Centro",
                        "stdValue": "CENTRO",
                        "score": 1
                      },
                      {
                        "name": "logradouro",
                        "stdName": "place",
                        "value": "Rua Paraná",
                        "stdValue": "RUA PARANA",
                        "score": 1
                      },
                      {
                        "name": "rotulo",
                        "stdName": "label",
                        "value": null,
                        "stdValue": null,
                        "score": null
                      },
                      {
                        "name": "numero",
                        "stdName": "number",
                        "value": "340",
                        "stdValue": "340",
                        "score": 1
                      }
                    ],
                    "secondaries": []
                  },
                  {
                    "name": "endereco_prestador",
                    "stdValue": "RUA ANA NERI, 416\nBAIRRO BENFICA\nCEP 20911442\nRIO DE JANEIRO - RJ - BRASIL",
                    "score": 1,
                    "components": [
                      {
                        "name": "cep",
                        "stdName": "postcode",
                        "value": "20911-442",
                        "stdValue": "20911442",
                        "score": 1
                      },
                      {
                        "name": "pais",
                        "stdName": "country",
                        "value": null,
                        "stdValue": "REPUBLICA FEDERATIVA DO BRASIL",
                        "score": null
                      },
                      {
                        "name": "estado",
                        "stdName": "state",
                        "value": "RJ",
                        "stdValue": "RIO DE JANEIRO",
                        "score": 1
                      },
                      {
                        "name": "cidade",
                        "stdName": "city",
                        "value": "RIO DE JANEIRO",
                        "stdValue": "RIO DE JANEIRO",
                        "score": 1
                      },
                      {
                        "name": "bairro",
                        "stdName": "suburb",
                        "value": "BENFICA",
                        "stdValue": "BENFICA",
                        "score": 1
                      },
                      {
                        "name": "logradouro",
                        "stdName": "place",
                        "value": "RUA ANA NERI",
                        "stdValue": "RUA ANA NERI",
                        "score": 1
                      },
                      {
                        "name": "rotulo",
                        "stdName": "label",
                        "value": null,
                        "stdValue": null,
                        "score": null
                      },
                      {
                        "name": "numero",
                        "stdName": "number",
                        "value": "416",
                        "stdValue": "416",
                        "score": 1
                      }
                    ],
                    "secondaries": []
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "requestId": "LmeEFuHfmkK1rtCJuovWh",
  "elapsedMilliseconds": 529,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟢200200 OK Response - Example 2

🔴500500 Error Response

🟠400400 Error Bad Request

🟠401401 Error - Unauthorized

MultiAddress Parsing [application/json]

Request body description:#

Contents#

Content#

Request

Request samples

Responses

Request body description:

Contents

Content