Search…
Identity Relations
The following endpoints are used to insert, retrieve, or delete entries representing identity relations from the database.
IDENTITY RELATIONS ENDPOINTS
1
GET /identity-relations/:id
2
POST /identity-relations/
3
DELETE /identity-relations/:id
Copied!

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
1
{
2
"id": "8b5e19fd-424f-4187-bb5f-a33a54bb38fa",
3
"fromIdentity": "6030f456-bcf7-4309-8de2-5ef2871c07d0",
4
"toIdentity": "a5b1857d-919f-4faa-859c-be665e5a6d9f",
5
"label": "CEO",
6
"createdAt": "2020-02-19T15:47:39.993Z",
7
"updatedAt": "2020-02-19T15:47:39.993Z"
8
}
Copied!
get
[ENVIRONMENT HOSTNAME]
/identity-relations/:id
GET /identity-relations/:id

Example Call

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

Example Call

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

Example Call

Request
Curl
1
DELETE [ENVIRONMENT HOSTNAME]/identity-relations/edd56760-39e7-45cd-8ca6-21add09ac548
2
Copied!
1
curl -X DELETE \
2
[ENVIRONMENT HOSTNAME]/identity-relations/edd56760-39e7-45cd-8ca6-21add09ac548 \
3
-H 'apikey: {INSERT API KEY HERE}'
Copied!
Last modified 1yr ago