Link external records to people and companies

curl --request POST \
  --url https://api.modem.dev/v1/identify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifications": [
    {
      "company": {
        "description": "<string>",
        "domains": [
          "<string>"
        ],
        "logoUrl": "<string>",
        "name": "<string>",
        "overwrite": []
      },
      "person": {
        "avatarUrl": "<string>",
        "description": "<string>",
        "displayName": "<string>",
        "email": "jsmith@example.com",
        "overwrite": []
      }
    }
  ]
}
'

import requests

url = "https://api.modem.dev/v1/identify"

payload = { "identifications": [
        {
            "company": {
                "description": "<string>",
                "domains": ["<string>"],
                "logoUrl": "<string>",
                "name": "<string>",
                "overwrite": []
            },
            "person": {
                "avatarUrl": "<string>",
                "description": "<string>",
                "displayName": "<string>",
                "email": "jsmith@example.com",
                "overwrite": []
            }
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifications: [
      {
        company: {
          description: '<string>',
          domains: ['<string>'],
          logoUrl: '<string>',
          name: '<string>',
          overwrite: []
        },
        person: {
          avatarUrl: '<string>',
          description: '<string>',
          displayName: '<string>',
          email: 'jsmith@example.com',
          overwrite: []
        }
      }
    ]
  })
};

fetch('https://api.modem.dev/v1/identify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.modem.dev/v1/identify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identifications' => [
        [
                'company' => [
                                'description' => '<string>',
                                'domains' => [
                                                                '<string>'
                                ],
                                'logoUrl' => '<string>',
                                'name' => '<string>',
                                'overwrite' => [
                                                                
                                ]
                ],
                'person' => [
                                'avatarUrl' => '<string>',
                                'description' => '<string>',
                                'displayName' => '<string>',
                                'email' => 'jsmith@example.com',
                                'overwrite' => [
                                                                
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modem.dev/v1/identify"

	payload := strings.NewReader("{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.modem.dev/v1/identify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modem.dev/v1/identify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "company": {
        "conflictWith": "<string>",
        "created": true,
        "id": "<string>"
      },
      "membershipLinked": true,
      "person": {
        "conflictWith": "<string>",
        "created": true,
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

Identify

Link external records to people and companies

Idempotently link external platform records (e.g. Stripe customers) to Modem people and companies.

Each person / company block states the facts the platform knows about that side of the record — not an assertion of how to resolve it. Modem owns all matching.

Person — matched by platform identity first, then by exact email. A bare email matches an existing person but never creates one (it may be a shared inbox like billing@); creation requires displayName.

Company — matched by the first hit, in trust order:

an existing platform identity link for this block
the resolved person’s current company
stated domains, then the domain derived from person.email (free-mail domains such as gmail.com carry no signal)
an exact, case-insensitive name match
otherwise created — only when name is stated

When both a person and a company resolve, their membership is recorded.

If the platform identity and a natural key (email/domain) resolve to different entities, the identity match wins and nothing is merged; the other entity is returned as conflictWith — a probable duplicate to reconcile deliberately.

Removing a stored link is not part of this endpoint; it will ship separately.

POST

identify

Link external records to people and companies

curl --request POST \
  --url https://api.modem.dev/v1/identify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifications": [
    {
      "company": {
        "description": "<string>",
        "domains": [
          "<string>"
        ],
        "logoUrl": "<string>",
        "name": "<string>",
        "overwrite": []
      },
      "person": {
        "avatarUrl": "<string>",
        "description": "<string>",
        "displayName": "<string>",
        "email": "jsmith@example.com",
        "overwrite": []
      }
    }
  ]
}
'

import requests

url = "https://api.modem.dev/v1/identify"

payload = { "identifications": [
        {
            "company": {
                "description": "<string>",
                "domains": ["<string>"],
                "logoUrl": "<string>",
                "name": "<string>",
                "overwrite": []
            },
            "person": {
                "avatarUrl": "<string>",
                "description": "<string>",
                "displayName": "<string>",
                "email": "jsmith@example.com",
                "overwrite": []
            }
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifications: [
      {
        company: {
          description: '<string>',
          domains: ['<string>'],
          logoUrl: '<string>',
          name: '<string>',
          overwrite: []
        },
        person: {
          avatarUrl: '<string>',
          description: '<string>',
          displayName: '<string>',
          email: 'jsmith@example.com',
          overwrite: []
        }
      }
    ]
  })
};

fetch('https://api.modem.dev/v1/identify', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.modem.dev/v1/identify",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identifications' => [
        [
                'company' => [
                                'description' => '<string>',
                                'domains' => [
                                                                '<string>'
                                ],
                                'logoUrl' => '<string>',
                                'name' => '<string>',
                                'overwrite' => [
                                                                
                                ]
                ],
                'person' => [
                                'avatarUrl' => '<string>',
                                'description' => '<string>',
                                'displayName' => '<string>',
                                'email' => 'jsmith@example.com',
                                'overwrite' => [
                                                                
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modem.dev/v1/identify"

	payload := strings.NewReader("{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.modem.dev/v1/identify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modem.dev/v1/identify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifications\": [\n    {\n      \"company\": {\n        \"description\": \"<string>\",\n        \"domains\": [\n          \"<string>\"\n        ],\n        \"logoUrl\": \"<string>\",\n        \"name\": \"<string>\",\n        \"overwrite\": []\n      },\n      \"person\": {\n        \"avatarUrl\": \"<string>\",\n        \"description\": \"<string>\",\n        \"displayName\": \"<string>\",\n        \"email\": \"jsmith@example.com\",\n        \"overwrite\": []\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "results": [
    {
      "company": {
        "conflictWith": "<string>",
        "created": true,
        "id": "<string>"
      },
      "membershipLinked": true,
      "person": {
        "conflictWith": "<string>",
        "created": true,
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

{
  "code": "NOT_FOUND",
  "defined": true,
  "message": "<string>",
  "status": 404,
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

Organization API key (modem_…).

Body

application/json

identifications

object[]

required

Required array length: 1 - 50 elements

Show child attributes

Response

results

object[]

required

Show child attributes

⌘I

Get Started

Endpoints

Link external records to people and companies

Authorizations

Body

Response