Search…
⌃K
Links

Identity Relations

The following endpoints are used to insert, retrieve, or delete entries representing identity relations from the database.
IDENTITY RELATIONS ENDPOINTS
GET /identity-relations/:id
POST /identity-relations/
DELETE /identity-relations/:id

The identity-relation object

The identity-relation object establishes the relation between a company identity and a person/company that is also a company officer.
A given identity-relation is identified by a unique, random id parameter.
IDENTITY RELATION OBJECT
{
"id": "8b5e19fd-424f-4187-bb5f-a33a54bb38fa",
"fromIdentity": "6030f456-bcf7-4309-8de2-5ef2871c07d0",
"toIdentity": "a5b1857d-919f-4faa-859c-be665e5a6d9f",
"label": "CEO",
"createdAt": "2020-02-19T15:47:39.993Z",
"updatedAt": "2020-02-19T15:47:39.993Z"
}
get
[ENVIRONMENT HOSTNAME]
/identity-relations/:id
GET /identity-relations/:id

Example Call

Request
Curl
Response
GET [ENVIRONMENT HOSTNAME]/identity-relations/8b5e19fd-424f-4187-bb5f-a33a54bb38fa
curl -X POST \
[ENVIRONMENT HOSTNAME]/identity-relations/8b5e19fd-424f-4187-bb5f-a33a54bb38fa \
-H 'Content-Type: application/json' \
-H 'apikey: {INSERT YOUR API KEY HERE}' \
{
"id": "8b5e19fd-424f-4187-bb5f-a33a54bb38fa",
"fromIdentity": "6030f456-bcf7-4309-8de2-5ef2871c07d0",
"toIdentity": "a5b1857d-919f-4faa-859c-be665e5a6d9f",
"label": "CEO",
"createdAt": "2020-02-19T15:47:39.993Z",
"updatedAt": "2020-02-19T15:47:39.993Z"
}
post
[ENVIRONMENT HOSTNAME]
/identity-relations/
POST /identity-relations

Example Call

Request
Curl
Response
POST [ENVIRONMENT HOSTNAME]/identity-relations/
curl -X POST \
[ENVIRONMENT HOSTNAME]/identity-relations \
-H 'Content-Type: application/json' \
-H 'apikey: {INSERT YOUR API KEY HERE}' \
-d '{
"companyIdentityId": "f51c7041-fdab-4f03-acaf-9c34df178724",
"relations": [
{
"id": "f51c7041-fdab-4f03-acaf-9c34df178724",
"label": "CEO"
}
]
}
{
"id": "8b5e19fd-424f-4187-bb5f-a33a54bb38fa",
"fromIdentity": "6030f456-bcf7-4309-8de2-5ef2871c07d0",
"toIdentity": "a5b1857d-919f-4faa-859c-be665e5a6d9f",
"label": "CEO",
"createdAt": "2020-02-19T15:47:39.993Z",
"updatedAt": "2020-02-19T15:47:39.993Z"
}
delete
[ENVIRONMENT HOSTNAME]
/identity-relations/:id
DELETE /identity-relations/:id

Example Call

Request
Curl
DELETE [ENVIRONMENT HOSTNAME]/identity-relations/edd56760-39e7-45cd-8ca6-21add09ac548
curl -X DELETE \
[ENVIRONMENT HOSTNAME]/identity-relations/edd56760-39e7-45cd-8ca6-21add09ac548 \
-H 'apikey: {INSERT API KEY HERE}'