{ "openapi": "3.0.0", "info": { "title": "klinsheet_collection", "version": "1.0.0", "description": "" }, "servers": [ { "url": "{{baseurl}}" } ], "paths": { "/registration/": { "post": { "summary": "registration", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fullname": { "type": "string" }, "email": { "type": "string", "format": "email" }, "password": { "type": "string" }, "phone": { "type": "string", "format": "utc-millisec" }, "company_name": { "type": "string" }, "industry": { "type": "string" } } }, "example": { "fullname": "Lu Abikoye", "email": "luabikodye@yahoo.com", "password": "Aledoy101!", "phone": "0801222321378", "company_name": "ABC Limited", "industry": "Technology" } } } } } }, "/login/": { "post": { "summary": "login", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" } } }, "example": { "email": "luabikoye@yahoo.com", "password": "Aledoy101!" } } } } } }, "/reset-password/": { "post": { "summary": "reset-password", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } } }, "example": { "email": "john@examddddddple.com" } } } } } }, "/service-list/": { "get": { "summary": "service-list", "responses": {} } }, "/create-request/": { "post": { "summary": "create-request", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "no_employees": { "type": "string", "format": "utc-millisec" }, "service_id": { "type": "string", "format": "utc-millisec" } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "no_employees": "3", "service_id": "11" } } } } } }, "/request-id-verification/": { "post": { "summary": "request-id-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "id_type": { "type": "string" }, "id_number": { "type": "string", "format": "utc-millisec" } } } } } }, "example": { "user_token": "671cf8b4623f3dd937f8298cb234cba6", "request_id": 2, "data": [ { "fullname": "John Doe", "date_of_birth": "1985-05-15", "id_type": "National ID", "id_number": "12345678901" }, { "fullname": "Jane Smith", "date_of_birth": "1990-08-20", "id_type": "Passport", "id_number": "A12345678" }, { "fullname": "Peter Johnson", "date_of_birth": "1988-11-10", "id_type": "Driver's License", "id_number": "DL123456789" } ] } } } } } }, "/request-address-verification/": { "post": { "summary": "request-address-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "address": { "type": "string" }, "landmark_bus_stop": { "type": "string" }, "phone_number": { "type": "string", "format": "utc-millisec" }, "image_path": { "type": "string" } } } } } }, "example": { "user_token": "671cf8b4623f3dd937f8298cb234cba6", "request_id": 3, "data": [ { "fullname": "John Doe", "address": "15 Allen Avenue, Ikeja, Lagos", "landmark_bus_stop": "Allen Bus Stop", "phone_number": "08012345678", "image_path": "/uploads/address/john-doe.jpg" }, { "fullname": "Jane Smith", "address": "24 Admiralty Way, Lekki Phase 1, Lagos", "landmark_bus_stop": "Admiralty Bus Stop", "phone_number": "08087654321", "image_path": "/uploads/address/jane-smith.jpg" } ] } } } } } }, "/request-guarantor-verification/": { "post": { "summary": "request-guarantor-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "organisation_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string", "format": "utc-millisec" }, "address": { "type": "string" }, "relationship": { "type": "string" }, "year_known": { "type": "string" } } } } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "request_id": 12, "data": [ { "fullname": "Bayo Adewale", "organisation_name": "ABC Technologies Limited", "email": "bayo@example.com", "phone": "08012345678", "address": "15 Allen Avenue, Ikeja, Lagos", "relationship": "Former Employer", "year_known": "5 years" }, { "fullname": "John Smith", "organisation_name": "XYZ Limited", "email": "john@example.com", "phone": "08098765432", "address": "25 Victoria Island, Lagos", "relationship": "Business Associate", "year_known": "3 years" }, { "fullname": "John Smith", "organisation_name": "XYZ Limited", "email": "john@example.com", "phone": "08098765432", "address": "25 Victoria Island, Lagos", "relationship": "Business Associate", "year_known": "3 years" } ] } } } } } }, "/request-marital-verification/": { "post": { "summary": "request-marital-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "marital_status": { "type": "string" }, "spouse_fullname": { "type": "string" }, "marriage_date": { "type": "string", "format": "date" }, "marriage_location": { "type": "string" }, "certificate_number": { "type": "string" } } } } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "request_id": 13, "data": [ { "fullname": "John Doe", "marital_status": "married", "spouse_fullname": "Jane Doe", "marriage_date": "2020-06-15", "marriage_location": "Lagos, Nigeria", "certificate_number": "MC-2020-00123" }, { "fullname": "Peter James", "marital_status": "single", "spouse_fullname": null, "marriage_date": null, "marriage_location": null, "certificate_number": null }, { "fullname": "Mary Johnson", "marital_status": "divorced", "spouse_fullname": "David Johnson", "marriage_date": "2018-03-20", "marriage_location": "Abuja, Nigeria", "certificate_number": "MC-2018-00456" } ] } } } } } }, "/request-employment-verification/": { "post": { "summary": "request-employment-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "organisation_name": { "type": "string" }, "position": { "type": "string" }, "contact_person": { "type": "string" }, "contact_person_email": { "type": "string", "format": "email" }, "contact_person_phone": { "type": "string", "format": "utc-millisec" }, "year_worked_from": { "type": "integer" }, "year_worked_to": { "type": "integer" } } } } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "request_id": 8, "data": [ { "fullname": "John Doe", "organisation_name": "ABC Technologies Limited", "position": "Software Engineer", "contact_person": "Mr James Brown", "contact_person_email": "james@abctech.com", "contact_person_phone": "08012345678", "year_worked_from": 2018, "year_worked_to": 2022 }, { "fullname": "Jane Smith", "organisation_name": "XYZ Consulting Limited", "position": "HR Manager", "contact_person": "Mrs Grace Williams", "contact_person_email": "grace@xyzconsulting.com", "contact_person_phone": "08087654321", "year_worked_from": 2020, "year_worked_to": 2025 } ] } } } } } }, "/request-education-verification/": { "post": { "summary": "request-education-verification", "responses": {} } }, "/request-criminal-verification/": { "post": { "summary": "request-criminal-verification", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "fullname": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "nationality": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string", "format": "utc-millisec" }, "state_of_residence": { "type": "string" }, "country_of_residence": { "type": "string" }, "identification_type": { "type": "string" }, "identification_number": { "type": "string", "format": "utc-millisec" }, "check_type": { "type": "string" } } } } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "request_id": 14, "data": [ { "fullname": "John Doe", "date_of_birth": "1990-05-12", "nationality": "Nigerian", "address": "19 oni street", "phone": "08023445647", "state_of_residence": "Lagos", "country_of_residence": "Nigeria", "identification_type": "NIN", "identification_number": "12345678901", "check_type": "National Criminal Record Check" } ] } } } } } }, "/request-details/": { "post": { "summary": "request-details", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "request_id": { "type": "integer" } } }, "example": { "request_id": 3 } } } } } }, "/payment/": { "get": { "summary": "payment", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "request_id": { "type": "integer" } } }, "example": { "user_token": "72faed9a507a98b739ae7910d707af07", "request_id": 15 } } } } } }, "/payment-callback/": { "get": { "summary": "payment-callback", "responses": {}, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_token": { "type": "string" }, "reference": { "type": "string" }, "request_id": { "type": "integer" } } }, "example": { "user_token": "671cf8b4623f3dd937f8298cb234cba6", "reference": "REQ-3-9B34198006", "request_id": 3 } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "BearerAuth": [] } ] }