Get one identity document with his UUID

GET 
/sint/id_doc/:uuid

Get one identity document with his UUID

Request

Path Parameters

uuid stringrequired

The UUID of the identity document you want to get

Responses

200

Return a identity document

application/json

Schema

Schema

• Array [
UUID string

$UUID

TypePiece integernullable

TypePieceID

Number stringnullable

Number

Validity object

Validity

oneOf

MOD1

string

MOD2

string

OwnerUUID stringnullable

OwnerUUID

algoregDocumentId stringnullable

AlgoregDocumentId

typePerLanguage string[]

TypePieceIdentie

selfUpload booleannullable

The document is uploaded by user

Document objectnullable
ExternalDocumentUUID stringnullable
Document UUID
fileName stringnullable
File name
base64Doc stringnullable
Base64 document to upload
fileURL stringnullable
File URL
uuid stringnullable
uuid stringnullable
• ]

Example (from schema)

[
  {
    "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
    "TypePiece": "1",
    "Number": "X4RTBPFW4",
    "Validity": "2024-02-15T16:52:44.036Z",
    "OwnerUUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
    "algoregDocumentId": "0a6e0a85-16f4-4b59-8adb-431fa37af8a1",
    "typePerLanguage": "['fr'=>Titre de séjour,'en'=>'Residence permis']",
    "selfUpload": "true",
    "Document": {
      "ExternalDocumentUUID": "5260643e-1b82-42f6-927c-d20558c2aa9b",
      "fileName": "IDCardFront.jpg",
      "base64Doc": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFh...",
      "fileURL": "https://your.backoffice.com/web/customerdocuments/0f7888a6-cc74-49a5-8377-21af10df9952/IDCardFront.jpg",
      "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
    },
    "uuid": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0"
  }
]

401

Unauthorized

application/json

Schema

Schema

code integer
message string

Example (from schema)

{
  "code": "401",
  "message": "JWT Token not found"
}

4XX|5XX

An error occured

application/json

Schema

Schema

success boolean
code integer
internal_code integer
message string

Example (from schema)

{
  "success": "false",
  "code": "400",
  "internal_code": "3001",
  "message": "Incorect data"
}

Loading...