How our API simplifies the EFFI broker operations
Zainuddin
Aug 1, 2024 - 8 min read
Endpoint
https://lnk8.co/api/public/v1/effi
Authorization
Include the api key in headers with custom property 'x-api-key'
x-api-key : <Your API Key>
All the endpoints require this header
Error Responses
On erroring you will get an appropriate status code with the reason in the following structure
{
error:<Reason for error>
}
Read Broker
Method - GET Path - /broker/:brokerId
Response -
{
"message": string,
"data": {
"brokerSlug": string,
"link":link,
"enabled":boolean,
"referrals": [
{
"referralSlug": string,
"leadApiKey": string,
"link":link
},
]
}
}
Create Broker
Method - POST Path - /broker/create
Payload -
{
"brokerSlug":<broker-slug>,
"brokerId":<effi-broker-id>,
"enabled"?:boolean}
Response -
{
"message": string,
"email": string,
"brokerSlug": string,
"link": url}
Update Broker
Method - POST Path - /broker/update
Payload -
{
"brokerSlug":<broker-slug>,
"brokerId":<effi-broker-id>,
"enabled"?:boolean}
Response -
{
"message": string,
"email": string,
"brokerSlug": string,
"link": url}
Create Broker Referral
Method - POST Path - /broker/referral/create
Payload -
{
"referralSlug":<broker-referral-slug>,
"brokerId":<effi-broker-id>,
"leadApiKey":<referral-lead-api-key>,}
Response -
{
"message": string,
"email": string,
"referralSlug": string,
"link": url}
Delete Broker Referral
Method - POST Path - /broker/referral/delete
Payload -
{
"referralSlug":<broker-referral-slug>,
"brokerId":<effi-broker-id>}
Response -
{
"message": string,
}
Create Broker Business Referral
Method - POST Path - /broker-house/referral/create
Payload -
{
"referralSlug":<broker-house-referral-slug>,
"legalEntityId":<broker-house-legalentity-id>,
"leadApiKey":<referral-lead-api-key>}
Response -
{
"message": string,
"referralSlug": string,
"link": url}
Delete Broker Business Referral
Method - POST Path - /broker-house/referral/delete
Payload -
{
"referralSlug":<broker-house-referral-slug>,
"legalEntityId":<broker-house-legalentity-id>,}
Response -
{
"message": string,
}
Read Broker Business
Method - GET Path - /broker-house/:legalEntityId
Response -
{
"message": string,
"data": {
"BusinessName": string,
"legalentityid": string,
"Email": string,
"RegistrationType": string,
"RegistrationNumber": string,
"LicenseType": string,
"LicenseNumber": string,
"address": string,
"Logo": url,
"slug": slug,
"Suffix": string,
"API": url,
"enabled": true,
"link":link
"referrals": [
{
"name": referral-slug,
"leadApiKey": string,
"link":link
},
]
}
}
Create Broker Business
Method - POST Path - /broker-house/create
Payload -
{
"address": string,
"API": url
"BusinessName": string,
"Email": string,
"enabled": boolean,
"legalentityid": string,
"LicenseNumber": string,
"LicenseType": string,
"Logo": url,
"RegistrationNumber": string,
"RegistrationType":string,
"slug": string,
"Suffix": string
}
Response -
{
"message": string,
"slug": string,
"link": url
}
Update Broker Business
Method - POST Path - /broker-house/update
Payload -
{
"legalentityid": string,
"address"?: string,
"API"?: url
"BusinessName"?: string,
"Email"?: string,
"enabled"?: boolean,
"LicenseNumber"?: string,
"LicenseType"?: string,
"Logo"?: url,
"RegistrationNumber"?: string,
"RegistrationType"?:string,
"slug"?: string,
"Suffix"?: string
}
Response -
{
"message": string,
"slug": string,
"link": url
}
Explore other blogs
Understanding password-less login: Simplifying authentication with OTPs
Passwordless login with Lnk8 is simple authentication without relying on passwords or any memorised phrases.
Securing every connection with SSL encryption
All the hosted sites, payment pages, and redirection domains are SSL encrypted on Lnk8. The custom domains connected are provided with an SSL certificate.
How Lnk8 ensures fast, secure, and reliable redirects
At Lnk8, URL redirection always happens closest to your end users, with low latency and high throughput.
Lnk8 is a growing database of experts across industries. Sign up as an expert or book a service with an expert on Lnk8.
E mail : [email protected]