API Documentation
The 6away engine analyses entities (people, companies, opportunities) and generates intelligent matches based on intent, context, and compatibility. You send us data, we send back ranked connections.
This reference covers everything you need to integrate with the 6away matching API — from authentication to webhooks.
Base URL
https://api.6away.ai/v1Authentication
All API requests require a Bearer token in the Authorization header. Get your API key from the 6away dashboard (coming soon) or request one via the early access form.
curl https://api.6away.ai/v1/matches \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json"Quick Start
Get up and running in two steps: create an entity, then request matches against your dataset.
1. Create an entity
curl -X POST https://api.6away.ai/v1/entities \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"type": "company",
"name": "Acme Finance",
"attributes": {
"industry": "fintech",
"markets": ["UAE", "UK"],
"looking_for": ["distribution partners"]
}
}'2. Request matches
curl -X POST https://api.6away.ai/v1/match \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"entity_id": "ent_abc123",
"limit": 10
}'Entities
An entity is anything you want to match — a person, company, deal, or opportunity. Each entity has a type, a name, and a flexible attributes object that the engine analyses to determine compatibility.
{
"type": "company",
"name": "Acme Finance",
"attributes": {
"industry": "fintech",
"markets": ["UAE", "UK", "EU"],
"services": ["cross-border payments", "FX hedging"],
"looking_for": ["distribution partners", "enterprise clients"]
}
}Supported entity types: company, person, opportunity, and deal. You can include any key-value pairs in attributes — the engine adapts to your schema.
Matching
When you request a match, the engine compares an entity against your dataset and returns ranked results with confidence scores and reasoning. Each match includes signals that explain why the connection was recommended.
The matching algorithm considers intent alignment, market overlap, service complementarity, and dozens of other contextual factors. Results are returned in descending order of confidence.
Confidence Scores
Every match response includes a confidence score between 0 and 1. Use these ranges to filter and prioritise results in your application.
POST/entities
Create a new entity in your dataset. The engine will index it for matching immediately.
Request
curl -X POST https://api.6away.ai/v1/entities \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"type": "company",
"name": "Acme Finance",
"attributes": {
"industry": "fintech",
"markets": ["UAE", "UK", "EU"],
"services": ["cross-border payments", "FX hedging"],
"looking_for": ["distribution partners", "enterprise clients"]
}
}'Response
{
"id": "ent_abc123",
"type": "company",
"name": "Acme Finance",
"attributes": {
"industry": "fintech",
"markets": ["UAE", "UK", "EU"],
"services": ["cross-border payments", "FX hedging"],
"looking_for": ["distribution partners", "enterprise clients"]
},
"created_at": "2026-03-13T10:30:00Z",
"status": "indexed"
}POST/match
Request matches for a given entity. Returns ranked results with confidence scores, reasoning, and matching signals.
Request
curl -X POST https://api.6away.ai/v1/match \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"entity_id": "ent_abc123",
"limit": 5,
"min_confidence": 0.6
}'Response
{
"matches": [
{
"entity_id": "ent_xyz789",
"name": "Gulf Ventures",
"score": 0.94,
"reasoning": "Strong alignment on cross-border payments in UAE market with complementary distribution network.",
"signals": [
{ "type": "market_overlap", "weight": 0.35, "detail": "Both active in UAE, UK" },
{ "type": "intent_match", "weight": 0.30, "detail": "Looking for distribution partners" },
{ "type": "service_fit", "weight": 0.29, "detail": "Complementary payment services" }
]
},
{
"entity_id": "ent_def456",
"name": "Nordic Pay",
"score": 0.82,
"reasoning": "Good fit for FX hedging partnership with EU market presence.",
"signals": [
{ "type": "market_overlap", "weight": 0.28, "detail": "EU presence" },
{ "type": "service_fit", "weight": 0.32, "detail": "FX and treasury services" },
{ "type": "intent_match", "weight": 0.22, "detail": "Enterprise client acquisition" }
]
}
],
"total": 2,
"entity_id": "ent_abc123"
}GET/matches
Retrieve previously computed matches for an entity. Supports pagination via offset and limit query parameters.
curl https://api.6away.ai/v1/matches?entity_id=ent_abc123&limit=20&offset=0 \
-H "Authorization: Bearer 6away_sk_live_..."GET/entities/:id
Retrieve a single entity by ID, including its current attributes and indexing status.
curl https://api.6away.ai/v1/entities/ent_abc123 \
-H "Authorization: Bearer 6away_sk_live_..."Webhooks
Subscribe to real-time events when new matches are found. Webhooks are sent as POST requests to your configured endpoint with the following payload:
{
"event": "match.created",
"timestamp": "2026-03-13T10:35:00Z",
"data": {
"entity_id": "ent_abc123",
"match_id": "mtch_001",
"matched_entity_id": "ent_xyz789",
"score": 0.94,
"reasoning": "Strong alignment on cross-border payments in UAE market."
}
}Configure a webhook endpoint
curl -X POST https://api.6away.ai/v1/webhooks \
-H "Authorization: Bearer 6away_sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-app.com/webhooks/6away",
"events": ["match.created", "match.updated"]
}'Integrations
Flowstack Live
Flowstack is 6away's native deal-flow and pipeline tool. The matching engine is deeply integrated — matches surface directly in your Flowstack workspace with full context, scores, and one-click actions. Visit flowstack.6away.ai to get started.
Zapier Coming Soon
Connect 6away to 5,000+ apps via Zapier. Trigger workflows when new matches are found, sync entities from your CRM, or push results to Slack and email.
HubSpot Coming Soon
Two-way sync with HubSpot CRM. Import contacts and companies as entities, and push match results back as activities and deal associations.
Salesforce Coming Soon
Native Salesforce integration with managed package. Sync Accounts, Contacts, and Opportunities with the 6away engine and view match results inside Salesforce.
Rate Limits
Rate limits depend on your plan. If you exceed the limit, the API returns a 429 Too Many Requests response with a Retry-After header.
Errors
The API uses standard HTTP status codes. All error responses follow a consistent JSON format.
Error response format
{
"error": {
"code": "invalid_entity",
"message": "The 'type' field is required and must be one of: company, person, opportunity, deal.",
"status": 400
}
}Changelog
- Initial public API release
- Entity creation and matching endpoints
- Webhook support for match events
- Flowstack integration