/ProofOfAddress/lite/id

POST

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id"),
    Content = new MultipartFormDataContent
    {
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "DocumentImageId",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "Side",
                }
            }
        },
        new StringContent("example")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("text/plain"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "CountryCode",
                }
            }
        },
        new StringContent("{ \"additionalProperty\": \"example\" }")
        {
            Headers =
            {
                ContentType = new MediaTypeHeaderValue("application/json"),
                ContentDisposition = new ContentDispositionHeaderValue("form-data")
                {
                    Name = "AdditionalDetails",
                }
            }
        },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id"

  payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"DocumentImageId\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Side\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"CountryCode\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalDetails\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"DocumentImageId\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Side\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"CountryCode\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalDetails\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
  .url("https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id")
  .post(body)
  .addHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .build();

Response response = client.newCall(request).execute();

const url = 'https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id';
const form = new FormData();
form.append('DocumentImageId', 'example');
form.append('Side', 'example');
form.append('CountryCode', 'example');
form.append('AdditionalDetails', '{ "additionalProperty": "example" }');

const options = {method: 'POST'};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"DocumentImageId\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"Side\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"CountryCode\"\r\nContent-Type: text/plain\r\n\r\nexample\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"AdditionalDetails\"\r\nContent-Type: application/json\r\n\r\n{ \"additionalProperty\": \"example\" }\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
  .url("https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id")
  .post(body)
  .addHeader("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
  .build()

val response = client.newCall(request).execute()

curl --request POST \
  --url https://verification-v2-eu.core.idscan.cloud/ProofOfAddress/lite/id \
  --header 'Content-Type: multipart/form-data' \
  --form DocumentImageId=example \
  --form Side=example \
  --form CountryCode=example \
  --form 'AdditionalDetails={ "additionalProperty": "example" }'

External endpoint to get the verification response of the Proof of Address A4 processed document using id of the image stored in cache/store.

IDscan Core Document POA Extraction Service endpoint allows a document to be uploaded (Please reach out to your support representative for the “IDscan Core Authentication Guide”). The document details will be extracted.

Authorizations

None

Parameters

Header Parameters

x-correlation-id

string

Correlation Id for the request

Request Body

multipart/form-data

object

DocumentImageId

A4 Document Image ID to be verified. (White image in normal light).

string

Side

The side of the document to be extracted.

string

CountryCode

The country code of the document (Mandatory for IDES provider).

string

AdditionalDetails

Pass any additional details, if required.

object

key

additional properties

string

nullable

RequestId

string

CorrelationId

string

Responses

200

Returns a success on the Endpoint after processing the submitted identity document/s.This code does not indicate a success on the validation of the document itself but rather a success on the call to the Endpoint.The document result is in the response body (See Response Body section below).

The response of the Proof of Address A4 document journey.

object

correlationId

string

nullable

extractedFields

Extracted fields from query document like first name, last name, birth date etc.

Array<object>

nullable

Represents an information element that is extracted or deducted from the document.

object

label

Extracted field name which is used to identify the field.

string

nullable

details

Field information about each source where the fields was located (viz, mrz, barcode).

Array<object>

nullable

Field information about each source where the fields was located (viz, mrz, barcode).

object

label

Extracted field name which is used to identify the field.

string

nullable

source

Source for field value (viz, pdf417_barcode, mrz, rfid, hybrid, barcode or viz).

string

nullable

value

Extracted field string value.

string

nullable

isNonLatin

Sets to true if the value is in Non Latin language, false otherwise.

boolean

regionOfInterest

Area of the document where the validation check was applied.

object

boundingBox

Surrounding box around the extracted field.

object

X coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

Y coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

width

Represents the width of the bounding box.

integer format: int32

height

Represents the height of the bounding box.

integer format: int32

side

Document side where the validation check was applied.

string

nullable

spectrum

Image type where the validation check was applied.

string

nullable

additionalDetails

Contains any additional details.

object

key

additional properties

string

nullable

extractedImage

Base64 encoded image of the extracted document.

string format: byte

nullable

The response of the Proof of Address A4 document journey.

object

correlationId

string

nullable

extractedFields

Extracted fields from query document like first name, last name, birth date etc.

Array<object>

nullable

Represents an information element that is extracted or deducted from the document.

object

label

Extracted field name which is used to identify the field.

string

nullable

details

Field information about each source where the fields was located (viz, mrz, barcode).

Array<object>

nullable

Field information about each source where the fields was located (viz, mrz, barcode).

object

label

Extracted field name which is used to identify the field.

string

nullable

source

Source for field value (viz, pdf417_barcode, mrz, rfid, hybrid, barcode or viz).

string

nullable

value

Extracted field string value.

string

nullable

isNonLatin

Sets to true if the value is in Non Latin language, false otherwise.

boolean

regionOfInterest

Area of the document where the validation check was applied.

object

boundingBox

Surrounding box around the extracted field.

object

X coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

Y coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

width

Represents the width of the bounding box.

integer format: int32

height

Represents the height of the bounding box.

integer format: int32

side

Document side where the validation check was applied.

string

nullable

spectrum

Image type where the validation check was applied.

string

nullable

additionalDetails

Contains any additional details.

object

key

additional properties

string

nullable

extractedImage

Base64 encoded image of the extracted document.

string format: byte

nullable

Example ^generated

{
  "extractedFields": [
    {
      "label": "example",
      "details": [
        {
          "label": "example",
          "source": "example",
          "value": "example",
          "isNonLatin": true,
          "regionOfInterest": {
            "boundingBox": {
              "x": 1,
              "y": 1,
              "width": 1,
              "height": 1
            },
            "side": "example",
            "spectrum": "example"
          }
        }
      ]
    }
  ],
  "additionalDetails": {
    "additionalProperty": "example"
  },
  "extractedImage": "example"
}

The response of the Proof of Address A4 document journey.

object

correlationId

string

nullable

extractedFields

Extracted fields from query document like first name, last name, birth date etc.

Array<object>

nullable

Represents an information element that is extracted or deducted from the document.

object

label

Extracted field name which is used to identify the field.

string

nullable

details

Field information about each source where the fields was located (viz, mrz, barcode).

Array<object>

nullable

Field information about each source where the fields was located (viz, mrz, barcode).

object

label

Extracted field name which is used to identify the field.

string

nullable

source

Source for field value (viz, pdf417_barcode, mrz, rfid, hybrid, barcode or viz).

string

nullable

value

Extracted field string value.

string

nullable

isNonLatin

Sets to true if the value is in Non Latin language, false otherwise.

boolean

regionOfInterest

Area of the document where the validation check was applied.

object

boundingBox

Surrounding box around the extracted field.

object

X coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

Y coordinate of the top left of the rectangle forming the bounding box.

integer format: int32

width

Represents the width of the bounding box.

integer format: int32

height

Represents the height of the bounding box.

integer format: int32

side

Document side where the validation check was applied.

string

nullable

spectrum

Image type where the validation check was applied.

string

nullable

additionalDetails

Contains any additional details.

object

key

additional properties

string

nullable

extractedImage

Base64 encoded image of the extracted document.

string format: byte

nullable

Example ^generated

{
  "extractedFields": [
    {
      "label": "example",
      "details": [
        {
          "label": "example",
          "source": "example",
          "value": "example",
          "isNonLatin": true,
          "regionOfInterest": {
            "boundingBox": {
              "x": 1,
              "y": 1,
              "width": 1,
              "height": 1
            },
            "side": "example",
            "spectrum": "example"
          }
        }
      ]
    }
  ],
  "additionalDetails": {
    "additionalProperty": "example"
  },
  "extractedImage": "example"
}

400

Error with the provided parameters, please, check the response provided to get more insights on the problem.

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

500

Internal error during our processing, please, get in touch with support so we can help you.

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

503

A downstream service is temporarily out of capacity, please, retry later.

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

object

correlationId

string

nullable

errorMessage

string

nullable

errors

Array<string>

nullable

Example ^generated

{
  "errorMessage": "example",
  "errors": [
    "example"
  ]
}

/ProofOfAddress/lite/id

Authorizations

Parameters

Header Parameters

Request Body

Responses

200

Example generated

Example generated

400

Example generated

Example generated

500

Example generated

Example generated

503

Example generated

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated