Skip to content

PPS

The overview describes the common field interpretation rules, failure reasons, and full/light file formats.

Parent: pps_result. Document photos retrieved by IIN, including reused photos.

Fields of pps_result.

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field JSON type Purpose and conditions
iin string Required. IIN used for the request, up to 12 characters.
status string, enum Required: UNAPPROVED, PENDING, VALID, COPIED, INVALID, TIMEOUT, NOT_FOUND, FAILED, ERROR_ACCEPTED; see the meanings.
source_session string, UUID Source session for a copied result.
photos object[] Required; may be []. All stored photos for the result, newest first.
result boolean Stored technology result: true means accepted, false means a negative result. May be absent before calculation; consider the status and the details below.
failure_reason object Failure reason, if recorded; see the structure.

Parent: pps_result.photos[].

Fields marked “Required” are always present within this object. Other fields are included when a value is available; null is excluded from the response.

Field JSON type Purpose and conditions
code_type_doc string Document type code from the provider, up to 64 characters.
num_doc string Document number, up to 50 characters.
photo string Photo URL when a file is available; a URL in both full and light responses.

JSON examples

Fragments of the root response object, not complete responses. All values and URLs are illustrative. File formats follow the explanations on this page.

{
  "pps_result": {
    "iin": "000000000000",
    "status": "COPIED",
    "result": true,
    "source_session": "44444444-4444-4444-8444-444444444444",
    "photos": [
      {
        "photo": "https://files.example.invalid/pps/photo.png"
      }
    ]
  }
}