Compliance API

This is the Compliance API that provides programmatic access to various resources and services. The API supports the following areas: Employment History Compliance, Address Compliance, Emergency Contact Complaince, Next of Kin Compliance. All endpoints require authentication using a Bearer token.

The compliance model

The compliance model contains all the information about your compliance entities.

Properties

Name
addressType
Type
string
Description
Value for addressType
Name
streetAddress
Type
string
Description
Value for streetAddress
Name
city
Type
string
Description
Value for city
Name
state
Type
string
Description
Current status or state of state
Name
postalCode
Type
string
Description
Value for postalCode
Name
country
Type
string
Description
Value for country
Name
isPrimary
Type
boolean
Description
Boolean flag indicating isPrimary
Name
validFrom
Type
string
Description
Value for validFrom
Name
validTo
Type
string
Description
Value for validTo

List Registered Addresses

Retrieves all registered addresses for user compliance verification and management

Request

GET

/v1/compliance/address

curl -G https://api.adiba.app/v1/compliance/address \
  -H "Authorization: Bearer {token}"

{
}

Add / Update Registered Address

Manages user address information for compliance and regulatory reporting requirements

Request

POST

/v1/compliance/address

curl -X POST https://api.adiba.app/v1/compliance/address \
  -H "Authorization: Bearer {token}" \
  -d '{
"addressType": "RESIDENTIAL",
"streetAddress": "123 Main Street, Victoria Island",
"city": "Lagos",
"state": "Lagos",
"postalCode": "101241",
"country": "Nigeria",
"isPrimary": true,
"validFrom": "2024-12-01",
"validTo": "2025-12-01"
}'

{
"addressId": "ADD_001_20241201_001",
"status": "SUCCESS",
"addressType": "RESIDENTIAL",
"validated": true,
"geocoded": true,
"createdAt": "2024-12-01T14:00:00Z",
"message": "Address registered successfully and validated against postal database"
}

List Next Of Kin

Retrieves next of kin information for emergency contact and compliance purposes

Request

GET

/v1/compliance/kin

curl -G https://api.adiba.app/v1/compliance/kin \
  -H "Authorization: Bearer {token}"

{
}

Add Next Of Kin

Registers new next of kin contact for emergency situations and compliance requirements

Request

POST

/v1/compliance/kin

curl -X POST https://api.adiba.app/v1/compliance/kin \
  -H "Authorization: Bearer {token}" \
  -d '{
"relationship": "SPOUSE",
"firstName": "Jane",
"lastName": "Doe",
"phoneNumber": "+2348012345679",
"email": "jane.doe@email.com",
"address": "123 Main Street, Victoria Island, Lagos",
"isPrimary": true,
"dateOfBirth": "1992-08-20",
"nationality": "Nigerian"
}'

{
"kinId": "KIN_001_20241201_003",
"status": "SUCCESS",
"relationship": "SPOUSE",
"verificationRequired": true,
"createdAt": "2024-12-01T15:00:00Z",
"message": "Next of kin added successfully. Verification required for contact details."
}

Update Next Of Kin

Modifies existing next of kin information with validation and audit tracking

Request

PUT

/v1/compliance/kin

curl -X PUT https://api.adiba.app/v1/compliance/kin \
  -H "Authorization: Bearer {token}" \
  -d '{
"kinId": "KIN_001_20241201_001",
"relationship": "SPOUSE",
"firstName": "Jane",
"lastName": "Smith",
"phoneNumber": "+2348012345679",
"email": "jane.smith@email.com",
"address": "123 Main Street, Victoria Island, Lagos",
"isPrimary": true,
"dateOfBirth": "1992-08-20",
"nationality": "Nigerian"
}'

{
"kinId": "KIN_001_20241201_001",
"status": "SUCCESS",
"updatedFields": [
    "lastName",
    "email"
],
"verificationRequired": true,
"updatedAt": "2024-12-01T15:15:00Z",
"message": "Next of kin information updated successfully. Email verification required."
}

Remove Next Of Kin

Removes next of kin contact with proper validation and compliance checks

Request

DELETE

/v1/compliance/kin

curl -X DELETE https://api.adiba.app/v1/compliance/kin \
  -H "Authorization: Bearer {token}" \
  -d '{
"example": "data"
}'

{
"kinId": "KIN_001_20241201_002",
"status": "SUCCESS",
"removedAt": "2024-12-01T15:30:00Z",
"reason": "Contact information outdated",
"message": "Next of kin contact removed successfully",
"remainingContacts": 1
}

List Employment History

Retrieves complete employment history for compliance and risk assessment purposes

Request

GET

/v1/compliance/employment

curl -G https://api.adiba.app/v1/compliance/employment \
  -H "Authorization: Bearer {token}"

{
}

Add Employment History

Registers new employment record for compliance verification and risk assessment

Request

POST

/v1/compliance/employment

curl -X POST https://api.adiba.app/v1/compliance/employment \
  -H "Authorization: Bearer {token}" \
  -d '{
"companyName": "Global Tech Solutions",
"position": "Senior Software Engineer",
"employmentType": "FULL_TIME",
"startDate": "2023-03-01",
"endDate": null,
"salary": "₦750,000 monthly",
"companyAddress": "456 Business District, Lagos",
"companyPhone": "+2348012345681",
"supervisorName": "Sarah Johnson",
"isCurrent": true
}'

{
"employmentId": "EMP_001_20241201_003",
"status": "SUCCESS",
"companyName": "Global Tech Solutions",
"verificationRequired": true,
"createdAt": "2024-12-01T16:15:00Z",
"message": "Employment record added successfully. Company verification required."
}

Update Employment History

Modifies existing employment records with validation and audit tracking

Request

PUT

/v1/compliance/employment

curl -X PUT https://api.adiba.app/v1/compliance/employment \
  -H "Authorization: Bearer {token}" \
  -d '{
"employmentId": "EMP_001_20241201_001",
"companyName": "Tech Solutions Ltd",
"position": "Senior Software Engineer",
"employmentType": "FULL_TIME",
"startDate": "2022-01-15",
"endDate": null,
"salary": "₦600,000 monthly",
"companyAddress": "123 Tech Street, Lagos",
"companyPhone": "+2348012345682",
"supervisorName": "Michael Brown",
"isCurrent": true
}'

{
"employmentId": "EMP_001_20241201_001",
"status": "SUCCESS",
"updatedFields": [
    "position",
    "salary",
    "supervisorName"
],
"verificationRequired": true,
"updatedAt": "2024-12-01T16:30:00Z",
"message": "Employment record updated successfully. Position and salary verification required."
}

Remove Employment History

Removes employment records with proper validation and compliance checks

Request

DELETE

/v1/compliance/employment

curl -X DELETE https://api.adiba.app/v1/compliance/employment \
  -H "Authorization: Bearer {token}" \
  -d '{
"example": "data"
}'

{
"employmentId": "EMP_001_20241201_002",
"status": "SUCCESS",
"removedAt": "2024-12-01T16:45:00Z",
"reason": "Employment ended and no longer relevant",
"message": "Employment record removed successfully",
"remainingRecords": 1
}

List Emergency Contact

Retrieves emergency contact information for crisis management and compliance purposes

Request

GET

/v1/compliance/emergency_contact

curl -G https://api.adiba.app/v1/compliance/emergency_contact \
  -H "Authorization: Bearer {token}"

{
}

Add Emergency Contact

Registers new emergency contact for crisis management and compliance requirements

Request

POST

/v1/compliance/emergency_contact

curl -X POST https://api.adiba.app/v1/compliance/emergency_contact \
  -H "Authorization: Bearer {token}" \
  -d '{
"relationship": "FRIEND",
"firstName": "Sarah",
"lastName": "Wilson",
"phoneNumber": "+2348012345684",
"email": "sarah.wilson@email.com",
"priority": "SECONDARY",
"address": "789 Friendship Street, Lagos",
"dateOfBirth": "1991-12-10"
}'

{
"contactId": "EMG_001_20241201_003",
"status": "SUCCESS",
"relationship": "FRIEND",
"priority": "SECONDARY",
"verificationRequired": true,
"createdAt": "2024-12-01T17:30:00Z",
"message": "Emergency contact added successfully. Contact verification required."
}

Update Emergency Contact

Modifies existing emergency contact information with validation and audit tracking

Request

PUT

/v1/compliance/emergency_contact

curl -X PUT https://api.adiba.app/v1/compliance/emergency_contact \
  -H "Authorization: Bearer {token}" \
  -d '{
"contactId": "EMG_001_20241201_001",
"relationship": "SPOUSE",
"firstName": "Jane",
"lastName": "Smith",
"phoneNumber": "+2348012345679",
"email": "jane.smith@email.com",
"priority": "PRIMARY",
"address": "123 Main Street, Victoria Island, Lagos",
"dateOfBirth": "1992-08-20"
}'

{
"contactId": "EMG_001_20241201_001",
"status": "SUCCESS",
"updatedFields": [
    "lastName",
    "email",
    "address"
],
"verificationRequired": true,
"updatedAt": "2024-12-01T17:45:00Z",
"message": "Emergency contact updated successfully. Contact verification required for changes."
}

Remove Emergency Contact

Removes emergency contact with proper validation and compliance checks

Request

DELETE

/v1/compliance/emergency_contact

curl -X DELETE https://api.adiba.app/v1/compliance/emergency_contact \
  -H "Authorization: Bearer {token}" \
  -d '{
"example": "data"
}'

{
"contactId": "EMG_001_20241201_002",
"status": "SUCCESS",
"removedAt": "2024-12-01T18:00:00Z",
"reason": "Contact moved abroad and no longer available",
"message": "Emergency contact removed successfully",
"remainingContacts": 1
}