Get OlkyPass info linked with an abstract entity

GET 
/sint/olkypass/:uuid

Get OlkyPass info linked with an abstract entity

Request

Path Parameters

uuid stringrequired

The UUID of the NaturalPerson or LegalEntity

Responses

200

Return an Olkypass

application/json

Schema

Schema

active booleannullable

OlkyPass need to be active to make transaction on customer

activeUntil date-timenullable

The OlkyPass will expire after this date, a new kyc session will need to be done to activate it again

createdAt date-timenullable

Created at

updatedAt date-timenullable

updated at

missingData string[]

Default value: ``

missingDocuments string[]

Default value: ``

identityDocuments object[]
Array [
UUID stringrequired
$UUID
TypePiece integernullable
TypePieceID
Number stringnullable
Number
Validity object nullable
Validity
oneOf
MOD1
string
MOD2
string
OwnerUUID stringnullable
OwnerUUID
algoregDocumentId stringnullable
AlgoregDocumentId
typePerLanguage string[]
Default value: ``
TypePieceIdentie
selfUpload booleannullable
The document is uploaded by user
Document object nullable
AlgoregDocument
oneOf
AlgoregDocumentDto
base64Doc stringnullable
Base64 document to upload
]
ValidForPayIn boolean

Default value: true

ValidForPayout boolean

Default value: true

olkypass_status object[]
Array [
name stringnullable
French name
englishName stringnullable
English name
createdAt date-timenullable
Created at
updatedAt date-timenullable
Updated at
deletedAt date-timenullable
Deleted at
]
olkypass_status_under_audit string[]

Example (from schema)

{
  "active": "true or false",
  "activeUntil": "2023-04-04 00:00:00",
  "createdAt": "2023-04-04 00:00:00",
  "updatedAt": "2023-04-04 00:00:00",
  "missingData": [
    "Identity verification"
  ],
  "missingDocuments": [
    "identity_card"
  ],
  "identityDocuments": [
    {
      "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
      "TypePiece": "1",
      "Number": "X4RTBPFW4",
      "Validity": "2024-11-28T17:04:27.564Z",
      "OwnerUUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
      "algoregDocumentId": "0a6e0a85-16f4-4b59-8adb-431fa37af8a1",
      "typePerLanguage": "['fr'=>Titre de s├®jour,'en'=>'Residence permis']",
      "selfUpload": "true",
      "Document": {}
    }
  ],
  "ValidForPayIn": "true",
  "ValidForPayout": "true",
  "olkypass_status": [
    {
      "name": "D├®claratif",
      "englishName": "Declarative",
      "createdAt": "2023-04-04 00:00:00",
      "updatedAt": "2023-04-04 00:00:00",
      "deletedAt": "2023-04-04 00:00:00"
    }
  ],
  "olkypass_status_under_audit": "[]"
}

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...