Create or update existing compliance data
POST/v1/partners/compliance
This endpoint creates or updates compliance data for different sections.
Request
- application/json
Body
required
Details of the compliance data for the selected section
- SlaComplianceRequest
- PersonalComplianceRequest
- BusinessComplianceRequest
- Array [
- ]
support_levels object[]
An array of support levels.
Possible values: [sla]
The section of the compliance document
The email address of the support team member.
The support level.
The last name of the support team member.
The first name of the support team member.
If you are creating this claim for a child partner, add the partner key to the request
Possible values: [personal]
The section of the compliance document
Possible values: [International Passport, Ghana Card,, Kenyan National ID,, Driving License,, Voter's Card,, Bank Verification Number,, National ID etc]
Name to describe the type of identification document in the id_file field
The identification number.
Possible values: >= 8 characters and <= 8 characters
The country code of residence e.g NG, GH, KE etc .
The state or province of the partner.
The street address of the partner.
The city.
The first name of the partner.
The last name of the partner.
The email address of the partner.
The phone number of the partner.
The file to be uploaded
The file to be uploaded as signature
If you are creating this claim for a child partner, add the partner key to the request
Possible values: [business]
The section of the compliance document
The name of the company.
The sector or industry the company operates in.
Possible values: >= 2 characters and <= 2 characters
The country where the company is incorporated e.g NG, GH, KE etc .
The Registration Number (RC number) of the company.
The state or province where the company is located.
The street address of the company.
A brief description of the company's business.
The city where the company is located.
Possible values: >= 8 characters and <= 8 characters
The Tax Identification Number (TIN) of the company.
The company's website URL.
Possible values: [CAC, Memart, Status_Report, Business_Registration_Certificate, Business_Commencement_Certificate, Form_3, Certificate_of_Incorporation, Form_CR1, Company_Incorporation_Document]
The binary file to upload. The name of the file must be in the enum value
If you are creating this claim for a child partner, add the partner key to the request
Responses
- 200
- 400
OK
- application/json
- Schema
- Example (from schema)
Schema
data object
Credit Note
The unique identifier for credit note
Current status of the policy
The credit note premium
Date when premium will be due
Date of creation
customer object
The the customer's information
Unique identifier for the customer on your system
The customer's email address
insurer object
An insurance provider
The unique code of the insurer
The name of the insurer
A link to the Insurer's logo
Insurer's terms and conditions
product object
An individual insurance product or plan
The name of the product
The unique identifier for technical purposes
Unique Id of the product.
insurer object
An insurance provider
The unique code of the insurer
The name of the insurer
A link to the Insurer's logo
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
The generally accepted human friendly name
The unique identifier for technical purposes
list of the nefits covered.
Date of product creation
Price of product
Define the product premium tier.
Possible values: [monthly, quarterly, annually]
Default value: annually
{
"data": {
"code": "CN-34243TF",
"status": "active",
"premium": 800000,
"premium_due_date": "2022-03-24",
"current_date": "2022-03-24",
"customer": {
"ref": "string",
"email": "string",
"phone": "408-867-5309",
"first_name": "Jane",
"last_name": "Doe"
},
"insurer": {
"code": "AXA",
"name": "Axa Mansard",
"logo_url": null,
"terms_conditions": null
},
"product": {
"title": "Comprehensive Car Plan XYZ",
"code": "auto-com-xyz",
"id": 1,
"insurer": {
"code": "AXA",
"name": "Axa Mansard",
"logo_url": null,
"terms_conditions": null
},
"product type": {
"name": "Goods in Transit",
"slug": "GIT"
},
"cover-benefits": {},
"created-at": "string",
"price": 0,
"premium-type": "string",
"premium-rate-unit": 0,
"premium-rate": 0,
"premium": 0,
"partner-commision-rate": 0,
"min-premium": "string",
"premium-rules": "string",
"premium_frequency": "annually"
}
}
}
Bad request.
- application/json
- Schema
- Example (from schema)
Schema
{
"message": "400 Bad Request (Client Error)"
}