Sign in

v1

latestOpenAPI 3.1.02026-07-26590236.8 KB

Create Document

post/entity_document

Request body

entity_type'person' | 'business' required
person_idstring
business_idstring
type'passport' | 'national_id' | 'drivers_licence' | 'residence_permit' | 'voters_card' | 'bank_statement' | 'utility_bill' | 'incorporation_certificate' | 'registration_certificate' | 'memorandum_articles' | 'business_licence' | 'cac' required
urlstring required
issuance_datestring
expiry_datestring

Response

200

messagestring
{"stackTrail":"paths:/entity_document:post:responses:200:content:application/json:schema:properties:meta","oasType":"schema","type":"unknown"}
statusstring

Example response

{
  "data": {
    "id": "d9c48e24bda811ef97d00edb5e3a61d3",
    "entity_type": "person",
    "person_id": "2c0090a9bd5511ef97d00edb5e3a61d3",
    "type": "passport",
    "url": "https://oval-staging.s3.amazonaws.com/kyc/8dbe79d36c1011ed8cc5dacad92d8272/person/fc9e05aa7625476189604cb6f7c5ba4c",
    "file_type": "image/png",
    "created_at": "2024-12-19T01:30:37Z",
    "updated_at": "2024-12-19T01:30:37Z"
  },
  "message": "Entity document created successfully",
  "status": "success"
}