FastAPI (0.1.0)

Download OpenAPI specification:Download

applications

Get Organisation Applications

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
401
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"applicant": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"proxy_id": "string"
}
]

Get Application By Id

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"applicant": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"proxy_id": "string"
}

Get Applicant

Authorizations:

OAuth2PasswordBearer

path Parameters

applicant_id

required

string (Applicant Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"organisation": "5eb7cf5a86d9755df3a6c593"
}

Get Organisations Applicants

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
401
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"organisation": "5eb7cf5a86d9755df3a6c593"
}
]

Create Applicant

Authorizations:

OAuth2PasswordBearer

Responses

Response samples

201
401

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"organisation": "5eb7cf5a86d9755df3a6c593"
}

Create Application

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

	Application Config Id (string) or Application Config Id (null) (Application Config Id)
applicant_id required	string (Applicant Id)
redirect_url required	string <uri> (Redirect Url) non-empty
	Expiry (string) or Expiry (null) (Expiry)

Responses

Request samples

Payload

Content type

application/json

{"application_config_id": "5eb7cf5a86d9755df3a6c593",
"applicant_id": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}

Response samples

201
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"applicant": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"proxy_id": "string",
"connect_url": "http://example.com"
}

Create Revet Application

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

	Application Config Id (string) or Application Config Id (null) (Application Config Id)
applicant_id required	string (Applicant Id)
redirect_url required	string <uri> (Redirect Url) non-empty
	Expiry (string) or Expiry (null) (Expiry)

Responses

Request samples

Payload

Content type

application/json

{"application_config_id": "5eb7cf5a86d9755df3a6c593",
"applicant_id": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"expiry": "2019-08-24T14:15:22Z"
}

Response samples

201
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"applicant": "5eb7cf5a86d9755df3a6c593",
"redirect_url": "http://example.com",
"proxy_id": "string",
"connect_url": "http://example.com"
}

Revet Submission

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

required	Array of objects (Applications)
	Application Config Id (string) or Application Config Id (null) (Application Config Id)

Responses

Request samples

Payload

Content type

application/json

{"applications": [{"name": "string",
"email": "user@example.com",
"phone": "string",
"contact_method": "email",
"installment_value": 0,
"loan_duration": 0,
"loan_amount": 0,
"number_of_installments": 0,
"effective_interest_rate": 0,
"reason_for_decline": "string"
}
],
"application_config_id": "5eb7cf5a86d9755df3a6c593"
}

Response samples

201
400
401
404
422

Content type

application/json

{ }

Revet Csv Submission

Authorizations:

OAuth2PasswordBearer

Request Body schema: multipart/form-data

file required	string <binary> (File)
application_config_id	string (Application Config Id)

Responses

Response samples

201
400
401
404
422

Content type

application/json

{ }

Revet Csv Template

Responses

Response samples

200
401

Content type

application/json

null

organisations

Get Organisation

Authorizations:

OAuth2PasswordBearer

Responses

Response samples

200
401

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"name_slug": "string"
}

bank_emails

Email Received

Responses

Response samples

200

Content type

application/json

null

Email Received

Responses

Response samples

200

Content type

application/json

null

Test Email Received

Responses

Response samples

200

Content type

application/json

null

application_configs

Get Connections Available

Responses

Response samples

200

Content type

application/json

{"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
]
}

Get Connections Available

Responses

Response samples

200

Content type

application/json

{"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
]
}

Get Data Point Args

Responses

Response samples

200

Content type

application/json

[{"type": "string",
"properties": [{"property_name": "string",
"type": "string"
}
],
"not_null": ["string"
]
}
]

Get Data Point Args

Responses

Response samples

200

Content type

application/json

[{"type": "string",
"properties": [{"property_name": "string",
"type": "string"
}
],
"not_null": ["string"
]
}
]

Get Application Configs By Id

Authorizations:

OAuth2PasswordBearer

path Parameters

app_config_id

required

string (App Config Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

Get Application Configs By Id

Authorizations:

OAuth2PasswordBearer

path Parameters

app_config_id

required

string (App Config Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

Get Application Configs By Organisation

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
401
404
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}
]

Get Application Configs By Organisation

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
401
404
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}
]

Create Application Config

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

name required	string (Name)
required	Array of objects (Connections) non-empty
is_default	boolean (Is Default) Default: false
	Default Redirect Url (string) or Default Redirect Url (null) (Default Redirect Url)
	Affinity Enabled (boolean) or Affinity Enabled (null) (Affinity Enabled) Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": false,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

Response samples

201
400
401
409
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

Create Application Config

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

name required	string (Name)
required	Array of objects (Connections) non-empty
is_default	boolean (Is Default) Default: false
	Default Redirect Url (string) or Default Redirect Url (null) (Default Redirect Url)
	Affinity Enabled (boolean) or Affinity Enabled (null) (Affinity Enabled) Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": false,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

Response samples

201
400
401
409
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"name": "string",
"organisation": "5eb7cf5a86d9755df3a6c593",
"connections": [{"name": "string",
"data_points": [{"name": "string",
"input_args": ["string"
],
"output_args": ["string"
]
}
]
}
],
"is_default": true,
"default_redirect_url": "http://example.com",
"affinity_enabled": false
}

personal_info_connections

Get Organisation Personal Connections By Id

Authorizations:

OAuth2PasswordBearer

path Parameters

connection_id

required

string (Connection Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
401
404
422

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"application": "5eb7cf5a86d9755df3a6c593",
"data": {"first_names": "string",
"last_names": "string",
"date_of_birth": "string",
"gov_id": "string",
"id_country": "string",
"id_type": "string",
"email": "user@example.com",
"phone": "string",
"nationality": "string"
}
}

Get Organisations Personal Connections

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
401
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"application": "5eb7cf5a86d9755df3a6c593",
"data": {"first_names": "string",
"last_names": "string",
"date_of_birth": "string",
"gov_id": "string",
"id_country": "string",
"id_type": "string",
"email": "user@example.com",
"phone": "string",
"nationality": "string"
}
}
]

Prefill Personal Info Form

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Request Body schema: application/json

first_names required	string (First Names) [ 2 .. 24 ] characters
last_names required	string (Last Names) [ 2 .. 24 ] characters
date_of_birth required	string <date> (Date Of Birth)
nationality required	string (Nationality)
id_type required	string (Id Type)
id_country required	string (Id Country)
email required	string <email> (Email)
	Phone (string) or Phone (null) (Phone)
gov_id required	string (Gov Id) [ 7 .. 13 ] characters

Responses

Request samples

Payload

Content type

application/json

{"first_names": "string",
"last_names": "string",
"date_of_birth": "2019-08-24",
"nationality": "string",
"id_type": "string",
"id_country": "string",
"email": "user@example.com",
"phone": "stringstri",
"gov_id": "strings"
}

Response samples

Content type

application/json

{"id": "5eb7cf5a86d9755df3a6c593",
"application": "5eb7cf5a86d9755df3a6c593",
"data": {"first_names": "string",
"last_names": "string",
"date_of_birth": "string",
"gov_id": "string",
"id_country": "string",
"id_type": "string",
"email": "user@example.com",
"phone": "string",
"nationality": "string"
}
}

connect

Email Received

Responses

Response samples

200

Content type

application/json

null

Email Received

Responses

Response samples

200

Content type

application/json

null

Test Email Received

Responses

Response samples

200

Content type

application/json

null

bank_connections

Get Labelled Transactions

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

[{"account": "string",
"transactions": [{"id": "string",
"datetime": "2019-08-24T14:15:22Z",
"amount": 0,
"description": "string",
"reference": "string",
"currency": "string",
"label": "string",
"balance": 0,
"bank_slug": "string"
}
]
}
]

Get Affordability

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"affordability": {"monthly_affordability": [{"year": 0,
"month": 0,
"primary_income": 0,
"secondary_income": 0,
"non_discretionary_expenses": 0,
"discretionary_expenses": 0,
"affordability_amount": 0,
"full_month": true
}
],
"average_full_month_primary_income": 0,
"average_full_month_secondary_income": 0,
"average_full_month_discretionary_expenses": 0,
"average_full_month_non_discretionary_expenses": 0,
"average_full_month_affordability": 0
}
}

Get Income Analysis

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"income_analysis": {"consistency_score": 0,
"longevity_score": 0,
"regularity_score": 0,
"income_month_breaks": 0,
"income_indicator": 0,
"months_back": 0,
"income_heatmap": {"property1": 0,
"property2": 0
},
"strike_date": 0
}
}

Get Risk Insights

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"risk_insights": {"begin_date": "string",
"end_date": "string",
"risk_insights": {"gambling_insights": {"monthly_gambling_analysis": [{"year": 0,
"month": 0,
"total_gambling_amount": 0,
"total_salary_amount": 0,
"gambling_proportion": 0
}
],
"monthly_average_gambling_spend": 0,
"monthly_average_gambling_proportion": 0
},
"overdraft_insights": {"total_days_in_overdraft": 0,
"total_proportion_of_days_in_overdraft": 0,
"unique_months": 0,
"monthly_average_days_in_overdraft": 0,
"monthly_overdraft_analysis": [{"year": 0,
"month": 0,
"days_in_overdraft": 0
}
]
},
"returned_debit_orders_insights": {"last_month_count": 0,
"last_3_months_count": 0,
"last_6_months_count": 0,
"last_12_months_count": 0,
"monthly_average_debit_order_value": 0
},
"atm_and_cash_insights": {"monthly_atm_and_cash_spend_analysis": [{"year": 0,
"month": 0,
"total_withdrawal_amount": 0,
"total_salary_amount": 0,
"cash_proportion": 0
}
],
"atm_and_cash_average_amount": 0,
"average_withdrawal_proportion": 0
},
"net_saver_spender_insights": {"net_saver_spender": "string"
},
"ssi_insights": {"monthly_ssi_analysis": [{"year": 0,
"month": 0,
"total_social_security_amount": 0
}
],
"monthly_average_ssi": 0
}
}
}
}

Get Liquidity Score

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"liquidity_score": {"start_date": "string",
"end_date": "string",
"field_30_day_liquidity_score": 0,
"field_60_day_liquidity_score": 0,
"field_90_day_liquidity_score": 0,
"balance_forecast": [{"date": "string",
"balance": 0
}
]
}
}

Get Health Score

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"health_score": {"affordability_score": 0,
"income_score": 0,
"expense_score": 0,
"liquidity_savings_score": 0,
"debt_score": 0,
"fee_score": 0,
"final_financial_health_score": 0
}
}

Get Expense Insights

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"expenses_insights": {"top_expense_amounts": [{"label": "string",
"amount": 0,
"average_monthly_spend": 0,
"percentage_of_total_spend": 0
}
],
"unique_months": 0,
"spend_split": {"discretionary_spend_percentage": 0,
"non_discretionary_spend_percentage": 0
}
}
}

Get Statements

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"accounts_summary": [{"account": "5eb7cf5a86d9755df3a6c593",
"account_type": "string",
"account_number": "string",
"bank": "string",
"account_name": "string",
"account_holder_name": "string",
"account_holder_gov_id": "string",
"account_holder_gov_id_verification_level": "ONLINE_BANKING_PROFILE",
"is_manual_upload": true,
"statement_date": "2019-08-24T14:15:22Z",
"statement_start_date": "2019-08-24T14:15:22Z",
"statement_end_date": "2019-08-24T14:15:22Z",
"opening_balance": 0,
"closing_balance": 0,
"total_transactions": 0,
"number_of_credit_transactions": 0,
"number_of_debit_transactions": 0,
"average_credit_transaction": 0,
"average_debit_transaction": 0,
"total_credit_amount": 0,
"total_debit_amount": 0
}
],
"primary_income": 0,
"primary_income_day": 0,
"account_holder_name": "string",
"account_holder_email": "string"
}

Byod

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Request Body schema: application/json

required

Array of objects (Accounts)

Array

account_number required	string (Account Number)
account_name required	string (Account Name)
	Account Type (string) or Account Type (null) (Account Type)
balance required	number (Balance)
currency	string (Currency) Default: "ZAR"
bank_slug required	string (Bank Slug)
account_holder_name required	string (Account Holder Name)
required	Array of objects (Transactions)

Responses

Request samples

Payload

Content type

application/json

{"accounts": [{"account_number": "string",
"account_name": "string",
"account_type": "string",
"balance": 0,
"currency": "ZAR",
"bank_slug": "string",
"account_holder_name": "string",
"transactions": [{"datetime": "2019-08-24T14:15:22Z",
"amount": 0,
"balance": 0,
"description": "string",
"reference": "string",
"currency": "ZAR"
}
]
}
]
}

Response samples

200
400
401
404
422

Content type

application/json

{"accounts": [{"id": "5eb7cf5a86d9755df3a6c593",
"account_number": "string",
"account_name": "string",
"account_type": "string",
"balance": 0,
"currency": "ZAR",
"bank_slug": "string",
"account_holder_name": "string",
"transactions": [{"id": "5eb7cf5a86d9755df3a6c593",
"datetime": "2019-08-24T14:15:22Z",
"amount": 0,
"balance": 0,
"description": "string",
"reference": "string",
"currency": "ZAR"
}
]
}
]
}

List Bank Slugs

Responses

Response samples

200
401

Content type

application/json

["string"
]

Get Labelled Transactions

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

[{"account": "string",
"transactions": [{"id": "string",
"datetime": "2019-08-24T14:15:22Z",
"amount": 0,
"description": "string",
"reference": "string",
"currency": "string",
"label": "string",
"balance": 0,
"bank_slug": "string"
}
]
}
]

Get Liquidity Score

Authorizations:

OAuth2PasswordBearer

path Parameters

application_id

required

string (Application Id)

Example: 5eb7cf5a86d9755df3a6c593

Responses

Response samples

200
400
401
404
422

Content type

application/json

{"bank_connection": "string",
"liquidity_score": {"start_date": "string",
"end_date": "string",
"field_30_day_liquidity_score": 0,
"field_60_day_liquidity_score": 0,
"field_90_day_liquidity_score": 0,
"balance_forecast": [{"date": "string",
"balance": 0
}
]
}
}

billing

Get Outstanding Bill Amount

Authorizations:

OAuth2PasswordBearer

Responses

Response samples

200

Content type

application/json

{"amount": 0
}

List Events

Authorizations:

OAuth2PasswordBearer

query Parameters

skip	integer (Skip) Default: 0
limit	integer (Limit) Default: 10

Responses

Response samples

200
422

Content type

application/json

[{"id": "5eb7cf5a86d9755df3a6c593",
"title": "string",
"type": "string",
"billed_price": 0,
"created_at": "2019-08-24T14:15:22Z",
"billable_item": "5eb7cf5a86d9755df3a6c593"
}
]

Get Pricing

Authorizations:

OAuth2PasswordBearer

Responses

Response samples

200

Content type

application/json

[{"display_title": "string",
"type": "string",
"price": 0
}
]

Xero Invoice Change

header Parameters

x-xero-signature

required

string (X-Xero-Signature)

Responses

Response samples

200
422

Content type

application/json

null

Xero Page

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Xero Auth Redirect

Responses

auth

Get Login

query Parameters

redirect_url

required

string (Redirect Url)

Responses

Response samples

200
422

Content type

application/json

null

Post Login

query Parameters

redirect_url

required

string (Redirect Url)

Responses

Response samples

201
422

Content type

application/json

null

payments

Peach Webhook

Responses

Response samples

200

Content type

application/json

{ }

Peach Webhook

Responses

Response samples

200

Content type

application/json

{ }

pdf_decrypt

Pdf Decrypt

query Parameters

error

string (Error)

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Decrypt File

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Request Body schema: application/x-www-form-urlencoded

file required	string <binary> (File)
password required	string (Password)

Responses

Response samples

200
422

Content type

application/json

null

white_label

Get Org White Label By Org Id

Authorizations:

OAuth2PasswordBearer

Responses

Response samples

200
401
404

Content type

application/json

{"display_name": "string",
"primary_colour_hex": "string",
"secondary_colour_hex": "string",
"image_url": "http://example.com",
"welcome_title": "string",
"welcome_description": "string"
}

Update Org Whitelabel

Authorizations:

OAuth2PasswordBearer

Request Body schema: application/json

	Display Name (string) or Display Name (null) (Display Name)
	Primary Colour Hex (string) or Primary Colour Hex (null) (Primary Colour Hex)
	Secondary Colour Hex (string) or Secondary Colour Hex (null) (Secondary Colour Hex)
	Image Base64 (string) or Image Base64 (null) (Image Base64)
	Welcome Title (string) or Welcome Title (null) (Welcome Title)
	Welcome Description (string) or Welcome Description (null) (Welcome Description)

Responses

Request samples

Payload

Content type

application/json

{"display_name": "string",
"primary_colour_hex": "string",
"secondary_colour_hex": "string",
"image_base64": "string",
"welcome_title": "string",
"welcome_description": "string"
}

Response samples

200
400
422

Content type

application/json

{"display_name": "string",
"primary_colour_hex": "string",
"secondary_colour_hex": "string",
"image_url": "http://example.com",
"welcome_title": "string",
"welcome_description": "string"
}

relabels

Get Relabels

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Update Relabels

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

200
422

Content type

application/json

null

Get Assigned Account

query Parameters

Error Message (string) or Error Message (null) (Error Message)

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

422

Content type

application/json

{"detail": [{"loc": ["string"
],
"msg": "string",
"type": "string"
}
]
}

Submit Assigned Account

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Request Body schema: application/x-www-form-urlencoded

account_id required	string (Account Id)
file required	string <binary> (File)

Responses

Response samples

200
422

Content type

application/json

null

Get Account Relabel File

path Parameters

account_id

required

string (Account Id)

Example: 5eb7cf5a86d9755df3a6c593

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

200
422

Content type

application/json

null

Regex Search

query Parameters

	Error Message Submit (string) or Error Message Submit (null) (Error Message Submit)
	Error Message Search (string) or Error Message Search (null) (Error Message Search)

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

200
422

Content type

application/json

null

Download Regex Search File

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Request Body schema: application/x-www-form-urlencoded

search_term

required

string (Search Term)

Responses

Response samples

200
422

Content type

application/json

null

Submit Search Relabels

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Request Body schema: application/x-www-form-urlencoded

file

required

string <binary> (File)

Responses

Response samples

200
422

Content type

application/json

null

Get Confirm Relabels

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

200
422

Content type

application/json

null

Update Confirm Relabels

cookie Parameters

Access Token (string) or Access Token (null) (Access Token)

Responses

Response samples

200
422

Content type

application/json

null

whatsapp

Register Waba Webhook

Responses

Response samples

200

Content type

application/json

true

zoho

Create Zoho Application

Request Body schema: application/x-www-form-urlencoded

firstName required	string (Firstname)
lastName required	string (Lastname)
email required	string (Email)
cellPhone required	string (Cellphone)
beamWebhookID required	string (Beamwebhookid)
dealID required	string (Dealid)

Responses

Response samples

200
400
404
422

Content type

application/json

{ }