/get_entity

Gets identifying information about a registered entity.

After having created a business or individual user at a handle with /register, you can view the registered information about the user with this endpoint. This endpoint also returns a certification token used for certifying individual beneficial owners after a business has been verified.

  

Requests

The request body at this endpoint is the header_msg JSON object.

header.user_handle should have the registered handle to be verified.

Both authsignature and usersignature headers are required for this request. The usersignature header should be generated with a keypair registered to the user (either registered from the /register endpoint or the /register_wallet endpoint). See authentication section for more details on how to generate this signature.

You can pass an optional query parameter, ?pretty_dates=true, at the end of the URL to see RFC3339-formatted dates alongside epoch timestamps, which can aid in debugging.

Note - We recently renamed the field auth_handle to app_handle. For backward compatibility, auth_handle is still valid but has been removed from our documentation.

  
POST /0.2/get_entity HTTP/1.1
Host: sandbox.silamoney.com
authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE]
usersignature: [GENERATED USERSIGNATURE HEX STRING HERE]
Content-Type: application/json

{
    "header": {
        "created": 1234567890,
        "app_handle": "your_app_handle",
        "user_handle": "your_individual_end_user",
        "reference": "<your unique id>"
    }
}

***

HTTP/1.1 200 OK

{
    "success": true,
    "status": "SUCCESS",
    "reference": "<your unique id>",
    "response_time_ms": "171",
    "user_handle": "your_individual_user",
    "entity_type": "individual",
    "entity": {
        "created_epoch": 1591402237,
        "entity_name": "Example User",
        "birthdate": "1990-08-31",
        "first_name": "Example",
        "last_name": "User"
    },
    "addresses": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "532e8b4c-6ba2-43e2-82d4-c3a964cef60f",
            "nickname": "Office",
            "street_address_1": "123 Example Way",
            "street_address_2": "",
            "city": "Portland",
            "state": "OR",
            "country": "US",
            "postal_code": "97222"
        }
    ],
    "identities": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "1e472c30-1086-4152-9092-b4eb0b268fbe",
            "identity_type": "SSN",
            "identity": "*2222"
        }
    ],
    "emails": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "a180ad8d-02d4-4677-8b87-20a204f07c68",
            "email": "[email protected]"
        }
    ],
    "phones": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "a33de417-4436-4cca-86ce-e8f4cea15812",
            "phone": "1231231234",
            "sms_confirmation_requested": false,
            "sms_confirmed": false,
            "primary": false
        }
    ],
    "devices": [
        {
            "added_epoch": 1628535928,
            "modified_epoch": 1628535928,
            "uuid": "4be0e2e8-58e8-4ed3-b7ff-9a3a261395f4"
        },
        {
            "added_epoch": 1628537120,
            "modified_epoch": 1628537120,
            "uuid": "cbf8909f-8b22-416b-8885-8414e30f564c"
        }
    ],
    "memberships": [
        {
            "business_handle": "business_user",
            "entity_name": "Your Business Co.",
            "role": "controlling_officer",
            "details": "CEO",
            "ownership_stake": null,
            "certification_token": null
        },
        {
            "business_handle": "business_user",
            "entity_name": "Your Business Co.",
            "role": "administrator",
            "details": null,
            "ownership_stake": null,
            "certification_token": null
        },
        {
            "business_handle": "business_user",
            "entity_name": "Your Business Co.",
            "role": "beneficial_owner",
            "details": null,
            "ownership_stake": 30.0,
            "certification_token": "2ef17fdedd98f18ef783a5955c217657ee382bc0"
        }
    ]
}
POST /0.2/get_entity HTTP/1.1
Host: sandbox.silamoney.com
authsignature: [GENERATED AUTHSIGNATURE HEX STRING HERE]
usersignature: [GENERATED USERSIGNATURE HEX STRING HERE]
Content-Type: application/json

{
    "header": {
        "created": 1234567890,
        "app_handle": "your_app_handle",
        "user_handle": "your_business_end_user",
        "reference": "<your unique id>"
    }
}

***

HTTP/1.1 200 OK

{
    "success": true,
    "user_handle": "your_business_end_user",
    "reference": "<your unique id>"
    "entity_type": "business",
    "entity": {
        "created_epoch": 1591749796,
        "entity_name": "Your Business Co.",
        "birthdate": null,
        "business_uuid": "f9d19e39-06b1-47a2-a028-4d6a2b87db38",
        "business_type": "corporation",
        "naics_code": 721,
        "naics_category": "Accommodation and Food Services",
        "naics_subcategory": "Accommodation",
        "doing_business_as": "Yours, Inc.",
        "business_website": "https://www.silamoney.com"
    },
    "addresses": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "5adce68c-039f-4109-83ad-b91d96b989f1",
            "nickname": "Office",
            "street_address_1": "1234 Example Also Ave.",
            "street_address_2": "",
            "city": "Portland",
            "state": "OR",
            "country": "US",
            "postal_code": "97333"
        }
    ],
    "identities": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "2807dfd5-7468-4459-b4c3-d70454e52b13",
            "identity_type": "EIN",
            "identity": "*7252"
        }
    ],
    "emails": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "3fd08fbf-af78-4789-bd53-b7f9b2dab272",
            "email": "[email protected]"
        }
    ],
    "phones": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "e090f8d5-fc47-4ab2-bcb7-f9381974c40b",
            "phone": "1231231234"
        }
    ],
    "members": [
        {
            "user_handle": "your_individual_end_user",
            "first_name": "Example",
            "last_name": "User",
            "role": "controlling_officer",
            "details": null,
            "ownership_stake": null
        }
    ]
}
const res = await sila.getEntity(user_handle, private_key);

// Success Response Object

// Individual
console.log(res.statusCode); // 200
console.log(res.data.success); // TRUE
console.log(res.data.status);
console.log(res.data.user_handle);
console.log(res.data.entity_type);
console.log(res.data.entity);
console.log(res.data.entity[0].created_epoch);
console.log(res.data.entity[0].entity_name);
console.log(res.data.entity[0].birthdate);
console.log(res.data.entity[0].first_name);
console.log(res.data.entity[0].last_name);
console.log(res.data.addresses);
console.log(res.data.addresses[0].added_epoch);
console.log(res.data.addresses[0].modified_epoch);
console.log(res.data.addresses[0].uuid);
console.log(res.data.addresses[0].nickname);
console.log(res.data.addresses[0].street_address_1);
console.log(res.data.addresses[0].street_address_2);
console.log(res.data.addresses[0].city);
console.log(res.data.addresses[0].state);
console.log(res.data.addresses[0].country);
console.log(res.data.addresses[0].postal_code);
console.log(res.data.identities);
console.log(res.data.identities[0].added_epoch);
console.log(res.data.identities[0].modified_epoch);
console.log(res.data.identities[0].uuid);
console.log(res.data.identities[0].identity_type);
console.log(res.data.identities[0].identity);
console.log(res.data.emails);
console.log(res.data.emails[0].added_epoch);
console.log(res.data.emails[0].modified_epoch);
console.log(res.data.emails[0].uuid);
console.log(res.data.emails[0].email);
console.log(res.data.phones);
console.log(res.data.phones[0].added_epoch);
console.log(res.data.phones[0].modified_epoch);
console.log(res.data.phones[0].uuid);
console.log(res.data.phones[0].phone);
console.log(res.data.memberships);
console.log(res.data.memberships[0].business_handle);
console.log(res.data.memberships[0].entity_name);
console.log(res.data.memberships[0].role);
console.log(res.data.memberships[0].details);
console.log(res.data.memberships[0].ownership_stake);
console.log(res.data.memberships[0].certification_token);
console.log(res.data.devices);
console.log(res.data.devices[0].added_epoch);
console.log(res.data.devices[0].modified_epoch);
console.log(res.data.devices[0].uuid);

// Business
console.log(res.statusCode); // 200
console.log(res.data.success); // TRUE
console.log(res.data.status);
console.log(res.data.user_handle);
console.log(res.data.entity_type);
console.log(res.data.entity);
console.log(res.data.entity[0].created_epoch);
console.log(res.data.entity[0].entity_name);
console.log(res.data.entity[0].birthdate);
console.log(res.data.entity[0].business_uuid);
console.log(res.data.entity[0].business_type);
console.log(res.data.entity[0].naics_code);
console.log(res.data.entity[0].naics_category);
console.log(res.data.entity[0].naics_subcategory);
console.log(res.data.entity[0].doing_business_as);
console.log(res.data.entity[0].business_website);
console.log(res.data.addresses);
console.log(res.data.addresses[0].added_epoch);
console.log(res.data.addresses[0].modified_epoch);
console.log(res.data.addresses[0].uuid);
console.log(res.data.addresses[0].nickname);
console.log(res.data.addresses[0].street_address_1);
console.log(res.data.addresses[0].street_address_2);
console.log(res.data.addresses[0].city);
console.log(res.data.addresses[0].state);
console.log(res.data.addresses[0].country);
console.log(res.data.addresses[0].postal_code);
console.log(res.data.identities);
console.log(res.data.identities[0].added_epoch);
console.log(res.data.identities[0].modified_epoch);
console.log(res.data.identities[0].uuid);
console.log(res.data.identities[0].identity_type);
console.log(res.data.identities[0].identity);
console.log(res.data.emails);
console.log(res.data.emails[0].added_epoch);
console.log(res.data.emails[0].modified_epoch);
console.log(res.data.emails[0].uuid);
console.log(res.data.emails[0].email);
console.log(res.data.phones);
console.log(res.data.phones[0].added_epoch);
console.log(res.data.phones[0].modified_epoch);
console.log(res.data.phones[0].uuid);
console.log(res.data.phones[0].phone);
console.log(res.data.members);
console.log(res.data.members[0].user_handle);
console.log(res.data.members[0].first_name);
console.log(res.data.members[0].last_name);
console.log(res.data.members[0].role);
console.log(res.data.members[0].details);
console.log(res.data.members[0].ownership_stake);
payload = {
    "user_handle": user_handle
}

response = User.getEntity(app, payload, user_private_key)

# Success Response Individual

{
    "status": 'SUCCESS',
    "success": true,
    "user_handle": "your_individual_user",
    "entity_type": "individual",
    "entity": {
        "created_epoch": 1591402237,
        "entity_name": "Postman User",
        "birthdate": "1990-08-31",
        "first_name": "Postman",
        "last_name": "User"
    },
    "addresses": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "532e8b4c-6ba2-43e2-82d4-c3a964cef60f",
            "nickname": "Office",
            "street_address_1": "920 SW 6th Ave.",
            "street_address_2": "",
            "city": "Portland",
            "state": "OR",
            "country": "US",
            "postal_code": "97204"
        }
    ],
    "identities": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "1e472c30-1086-4152-9092-b4eb0b268fbe",
            "identity_type": "SSN",
            "identity": "*2222"
        }
    ],
    "emails": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "a180ad8d-02d4-4677-8b87-20a204f07c68",
            "email": "[email protected]"
        }
    ],
    "phones": [
        {
            "added_epoch": 1591402237,
            "modified_epoch": 1591402237,
            "uuid": "a33de417-4436-4cca-86ce-e8f4cea15812",
            "phone": "1231231234"
        }
    ],
    "memberships": [
        {
            "business_handle": "business_user",
            "entity_name": "Sila, Inc.",
            "role": "controlling_officer",
            "details": null,
            "ownership_stake": null,
            "certification_token": null
        },
    ],
    "devices": [
    {
      "added_epoch": 1632389358,
      "modified_epoch": 1632389358,
      "uuid": "c49db8d8-3f77-4c28-896d-543d62f73235"
    }
  ]
}

# Success Response Business

{
    "status": 'SUCCESS',
    "success": true,
    "user_handle": "kyb-test-3-business",
    "entity_type": "business",
    "entity": {
        "created_epoch": 1591749796,
        "entity_name": "Sila, Inc.",
        "birthdate": null,
        "business_uuid": "f9d19e39-06b1-47a2-a028-4d6a2b87db38",
        "business_type": "corporation",
        "naics_code": 721,
        "naics_category": "Accommodation and Food Services",
        "naics_subcategory": "Accommodation",
        "doing_business_as": "Sila",
        "business_website": "https://www.silamoney.com"
    },
    "addresses": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "5adce68c-039f-4109-83ad-b91d96b989f1",
            "nickname": "Office",
            "street_address_1": "920 SW 6th Ave.",
            "street_address_2": "",
            "city": "Portland",
            "state": "OR",
            "country": "US",
            "postal_code": "97204"
        }
    ],
    "identities": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "2807dfd5-7468-4459-b4c3-d70454e52b13",
            "identity_type": "EIN",
            "identity": "*7252"
        }
    ],
    "emails": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "3fd08fbf-af78-4789-bd53-b7f9b2dab272",
            "email": "[email protected]"
        }
    ],
    "phones": [
        {
            "added_epoch": 1591749796,
            "modified_epoch": 1591749796,
            "uuid": "e090f8d5-fc47-4ab2-bcb7-f9381974c40b",
            "phone": "1231231234"
        }
    ],
    "members": [
        {
            "user_handle": "kyb-test-1-individual",
            "first_name": "Postman",
            "last_name": "User",
            "role": "controlling_officer",
            "details": null,
            "ownership_stake": null
        }
    ]
}
// Get Entity (individual)
ApiResponse response = api.getEntity("user handle", "user private key");

// Success Object Response
System.out.println(response.getStatusCode()); // 200
((GetEntityResponse)response.getData()).isSuccess(); // true
((GetEntityResponse)response.getData()).getUserHandle(); // user
((GetEntityResponse)response.getData()).getEntityType(); // "individual"
((GetEntityResponse)response.getData()).getEntity(); // Get entity object
((GetEntityResponse)response.getData()).getEntity().getCreatedEpoch();
((GetEntityResponse)response.getData()).getEntity().getEntityName();
((GetEntityResponse)response.getData()).getEntity().getBirthdate();
((GetEntityResponse)response.getData()).getEntity().getFirstName();
((GetEntityResponse)response.getData()).getEntity().getLastName();
((GetEntityResponse)response.getData()).getAddresses(); // Get addresses list
((GetEntityResponse)response.getData()).getAddresses().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getAddresses().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getAddresses().get(0).getUuid();
((GetEntityResponse)response.getData()).getAddresses().get(0).getNickname();
((GetEntityResponse)response.getData()).getAddresses().get(0).getStreetAddress1();
((GetEntityResponse)response.getData()).getAddresses().get(0).getStreetAddress2();
((GetEntityResponse)response.getData()).getAddresses().get(0).getCity();
((GetEntityResponse)response.getData()).getAddresses().get(0).getState();
((GetEntityResponse)response.getData()).getAddresses().get(0).getCountry();
((GetEntityResponse)response.getData()).getAddresses().get(0).getPostalCode();
((GetEntityResponse)response.getData()).getIdentities(); // Get identities list
((GetEntityResponse)response.getData()).getIdentities().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getIdentities().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getIdentities().get(0).getUuid();
((GetEntityResponse)response.getData()).getIdentities().get(0).getIdentity();
((GetEntityResponse)response.getData()).getEmails(); // Get emails list
((GetEntityResponse)response.getData()).getEmails().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getEmails().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getEmails().get(0).getUuid();
((GetEntityResponse)response.getData()).getEmails().get(0).getEmail();
((GetEntityResponse)response.getData()).getPhones(); // Get phones list
((GetEntityResponse)response.getData()).getPhones().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getPhones().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getPhones().get(0).getUuid();
((GetEntityResponse)response.getData()).getPhones().get(0).getPhone();
((GetEntityResponse)response.getData()).getPhones().get(0).getSmsConfirmationRequested(); // true or false
((GetEntityResponse)response.getData()).getPhones().get(0).getSmsConfirmed();
((GetEntityResponse)response.getData()).getMemberships(); // Get memberships list
((GetEntityResponse)response.getData()).getMemberships().get(0).getBusinessHandle();
((GetEntityResponse)response.getData()).getMemberships().get(0).getEntityName();
((GetEntityResponse)response.getData()).getMemberships().get(0).getRole();
((GetEntityResponse)response.getData()).getMemberships().get(0).getDetails();
((GetEntityResponse)response.getData()).getMemberships().get(0).getOwnershipStake();
((GetEntityResponse)response.getData()).getMemberships().get(0).getCertificationToken();
((GetEntityResponse)response.getData()).getDevices(); // Get devices list
((GetEntityResponse)response.getData()).getDevices().get(0).getAddedEpoch();;
((GetEntityResponse)response.getData()).getDevices().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getDevices().get(0).getUuid();

// Get Entity (business)
ApiResponse response = api.getEntity("business handle", "business private key");

// Success Object Response
System.out.println(response.getStatusCode()); // 200
((GetEntityResponse)response.getData()).isSuccess(); // true
((GetEntityResponse)response.getData()).getUserHandle(); // user
((GetEntityResponse)response.getData()).getEntityType(); // "individual"
((GetEntityResponse)response.getData()).getStatus(); // "status"
((GetEntityResponse)response.getData()).getEntity(); // Get entity object
((GetEntityResponse)response.getData()).getEntity().getCreatedEpoch();
((GetEntityResponse)response.getData()).getEntity().getEntityName();
((GetEntityResponse)response.getData()).getEntity().getBirthdate();
((GetEntityResponse)response.getData()).getEntity().getBusinessUuid();
((GetEntityResponse)response.getData()).getEntity().getBusinessType();
((GetEntityResponse)response.getData()).getEntity().getNaicsCode();
((GetEntityResponse)response.getData()).getEntity().getNaicsCategory();
((GetEntityResponse)response.getData()).getEntity().getDoingBusinessAs();
((GetEntityResponse)response.getData()).getEntity().getBusinessWebsite();
((GetEntityResponse)response.getData()).getAddresses(); // Get addresses list
((GetEntityResponse)response.getData()).getAddresses().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getAddresses().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getAddresses().get(0).getUuid();
((GetEntityResponse)response.getData()).getAddresses().get(0).getNickname();
((GetEntityResponse)response.getData()).getAddresses().get(0).getStreetAddress1();
((GetEntityResponse)response.getData()).getAddresses().get(0).getStreetAddress2();
((GetEntityResponse)response.getData()).getAddresses().get(0).getCity();
((GetEntityResponse)response.getData()).getAddresses().get(0).getState();
((GetEntityResponse)response.getData()).getAddresses().get(0).getCountry();
((GetEntityResponse)response.getData()).getAddresses().get(0).getPostalCode();
((GetEntityResponse)response.getData()).getIdentities(); // Get identities list
((GetEntityResponse)response.getData()).getIdentities().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getIdentities().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getIdentities().get(0).getUuid();
((GetEntityResponse)response.getData()).getIdentities().get(0).getIdentity();
((GetEntityResponse)response.getData()).getIdentities().get(0).getIdentityType();
((GetEntityResponse)response.getData()).getEmails(); // Get emails list
((GetEntityResponse)response.getData()).getEmails().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getEmails().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getEmails().get(0).getUuid();
((GetEntityResponse)response.getData()).getEmails().get(0).getEmail();
((GetEntityResponse)response.getData()).getPhones(); // Get phones list
((GetEntityResponse)response.getData()).getPhones().get(0).getAddedEpoch();
((GetEntityResponse)response.getData()).getPhones().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getPhones().get(0).getUuid();
((GetEntityResponse)response.getData()).getPhones().get(0).getPhone();
((GetEntityResponse)response.getData()).getPhones().get(0).getSmsConfirmationRequested();
((GetEntityResponse)response.getData()).getPhones().get(0).getSmsConfirmed();
((GetEntityResponse)response.getData()).getMembers(); // Get members list
((GetEntityResponse)response.getData()).getMembers().get(0).getUserHandle();
((GetEntityResponse)response.getData()).getMembers().get(0).getFirstName();
((GetEntityResponse)response.getData()).getMembers().get(0).getLastName();
((GetEntityResponse)response.getData()).getMembers().get(0).getRole();
((GetEntityResponse)response.getData()).getMembers().get(0).getDetails();
((GetEntityResponse)response.getData()).getMembers().get(0).getOwnershipStake();
((GetEntityResponse)response.getData()).getMembers().get(0).getVerificationStatus();
((GetEntityResponse)response.getData()).getMembers().get(0).getVerificationRequired();
((GetEntityResponse)response.getData()).getMembers().get(0).getVerificationId();
((GetEntityResponse)response.getData()).getMembers().get(0).getBeneficialOwnerCertificationStatus();
((GetEntityResponse)response.getData()).getMembers().get(0).getBusinessCertificationStatus();
((GetEntityResponse)response.getData()).getDevices(); // Get devices list
((GetEntityResponse)response.getData()).getDevices().get(0).getAddedEpoch();;
((GetEntityResponse)response.getData()).getDevices().get(0).getModifiedEpoch();
((GetEntityResponse)response.getData()).getDevices().get(0).getUuid();
$handle = 'user.silamoney.eth'; // The user to retrieve details from
$privateKey = 'some private key';

$response = $client->getEntity($handle, $privateKey);
// Response 200 Individual

echo $response->getStatusCode(); // 200
echo $response->getData()->success; // TRUE
echo $response->getData()->status;
echo $response->getData()->user_handle; // The requested user handle
echo $response->getData()->entity_type; // individual
echo $response->getData()->entity; // Details for the entity (first name, last name, birthdate...)
echo $response->getData()->entity->created_epoch;
echo $response->getData()->entity->entity_name;
echo $response->getData()->entity->birthdate;
echo $response->getData()->entity->first_name;
echo $response->getData()->entity->last_name;
echo $response->getData()->addresses; // An array of registered addresses to the entity (street address 1, city...)
echo $response->getData()->addresses[0]->added_epoch;
echo $response->getData()->addresses[0]->modified_epoch;
echo $response->getData()->addresses[0]->uuid;
echo $response->getData()->addresses[0]->nickname;
echo $response->getData()->addresses[0]->street_address_1;
echo $response->getData()->addresses[0]->street_address_2;
echo $response->getData()->addresses[0]->city;
echo $response->getData()->addresses[0]->state;
echo $response->getData()->addresses[0]->country;
echo $response->getData()->addresses[0]->postal_code;
echo $response->getData()->identities; // An array of registered identity numbers to the entity (identity type, identity)
echo $response->getData()->identities[0]->added_epoch;
echo $response->getData()->identities[0]->modified_epoch;
echo $response->getData()->identities[0]->uuid;
echo $response->getData()->identities[0]->identity_type;
echo $response->getData()->identities[0]->identity;
echo $response->getData()->emails; // An array of registered emails to the entity (email)
echo $response->getData()->emails[0]->added_epoch;
echo $response->getData()->emails[0]->modified_epoch;
echo $response->getData()->emails[0]->uuid;
echo $response->getData()->emails[0]->email;
echo $response->getData()->phones; // An array of registered phones to the entity (phone)
echo $response->getData()->phones[0]->added_epoch;
echo $response->getData()->phones[0]->modified_epoch;
echo $response->getData()->phones[0]->uuid;
echo $response->getData()->phones[0]->phone;
echo $response->getData()->memberships; // An array of registered roles in businesses (business handle, entity name, role, certification token...)
echo $response->getData()->memberships[0]->business_handle;
echo $response->getData()->memberships[0]->entity_name;
echo $response->getData()->memberships[0]->role;
echo $response->getData()->memberships[0]->details;
echo $response->getData()->memberships[0]->ownership_stake;
echo $response->getData()->memberships[0]->certification_token;
echo $response->getData()->devices; // An array of registered devices
echo $response->getData()->devices[0]->added_epoch;
echo $response->getData()->devices[0]->modified_epoch;
echo $response->getData()->devices[0]->uuid;


// Response 200 Business

echo $response->getStatusCode(); // 200
echo $response->getData()->success; // TRUE
echo $response->getData()->status;
echo $response->getData()->user_handle; // The requested user handle
echo $response->getData()->entity_type; // individual
echo $response->getData()->entity; // Details for the entity (first name, last name, birthdate...)
echo $response->getData()->entity->created_epoch;
echo $response->getData()->entity->entity_name;
echo $response->getData()->entity->birthdate;
echo $response->getData()->entity->business_uuid;
echo $response->getData()->entity->business_type;
echo $response->getData()->entity->naics_code;
echo $response->getData()->entity->naics_category;
echo $response->getData()->entity->naics_subcategory;
echo $response->getData()->entity->doing_business_as;
echo $response->getData()->entity->business_website;
echo $response->getData()->addresses; // An array of registered addresses to the entity (street address 1, city...)
echo $response->getData()->addresses[0]->added_epoch;
echo $response->getData()->addresses[0]->modified_epoch;
echo $response->getData()->addresses[0]->uuid;
echo $response->getData()->addresses[0]->nickname;
echo $response->getData()->addresses[0]->street_address_1;
echo $response->getData()->addresses[0]->street_address_2;
echo $response->getData()->addresses[0]->city;
echo $response->getData()->addresses[0]->state;
echo $response->getData()->addresses[0]->country;
echo $response->getData()->addresses[0]->postal_code;
echo $response->getData()->identities; // An array of registered identity numbers to the entity (identity type, identity)
echo $response->getData()->identities[0]->added_epoch;
echo $response->getData()->identities[0]->modified_epoch;
echo $response->getData()->identities[0]->uuid;
echo $response->getData()->identities[0]->identity_type;
echo $response->getData()->identities[0]->identity;
echo $response->getData()->emails; // An array of registered emails to the entity (email)
echo $response->getData()->emails[0]->added_epoch;
echo $response->getData()->emails[0]->modified_epoch;
echo $response->getData()->emails[0]->uuid;
echo $response->getData()->emails[0]->email;
echo $response->getData()->phones; // An array of registered phones to the entity (phone)
echo $response->getData()->phones[0]->added_epoch;
echo $response->getData()->phones[0]->modified_epoch;
echo $response->getData()->phones[0]->uuid;
echo $response->getData()->phones[0]->phone;
echo $response->getData()->members;
echo $response->getData()->members[0]->user_handle;
echo $response->getData()->members[0]->first_name;
echo $response->getData()->members[0]->last_name;
echo $response->getData()->members[0]->role;
echo $response->getData()->members[0]->details;
echo $response->getData()->members[0]->ownership_stake;
echo $response->getData()->devices; // An array of registered devices
echo $response->getData()->devices[0]->added_epoch;
echo $response->getData()->devices[0]->modified_epoch;
echo $response->getData()->devices[0]->uuid;
// Get Entity (individual)
bool? prettyDates = null; //optional field 
ApiResponse<object> response = api.GetEntity("user handle", "user private key", prettyDates);

// Success object response

Console.WriteLine(response.StatusCode); // 200
var parsedResponse = (GetEntityResponse)response.Data;// Access to entity properties

Console.WriteLine(parsedResponse.Success); // Success
Console.WriteLine(parsedResponse.UserHandle); // User handle
Console.WriteLine(parsedResponse.EntityType); // Entity type
Console.WriteLine(parsedResponse.Entity); // Entity details
Console.WriteLine(parsedResponse.Addresses); // Addresses details
Console.WriteLine(parsedResponse.Identities); // Identities details
Console.WriteLine(parsedResponse.Emails); // Emails details 
Console.WriteLine(parsedResponse.Phones); // Phones 
Console.WriteLine(parsedResponse.Memberships); // Memberships list 

Console.WriteLine(parsedResponse.Entity.CreatedEpoch); // Created Epoch
Console.WriteLine(parsedResponse.Entity.Created); // Created
Console.WriteLine(parsedResponse.Entity.Birthdate); // Birthdate
Console.WriteLine(parsedResponse.Entity.EntityName); // Entity Name
Console.WriteLine(parsedResponse.Entity.LastName); // Last Name
Console.WriteLine(parsedResponse.Entity.FirstName); // First Name
Console.WriteLine(parsedResponse.Entity.NaicsCode); // Naics Code
Console.WriteLine(parsedResponse.Entity.NaicsCategory); // Naics Category
Console.WriteLine(parsedResponse.Entity.NaicsSubcategory); // Naics Sub category

Console.WriteLine(parsedResponse.Addresses[0].Country); // Country
Console.WriteLine(parsedResponse.Addresses[0].City); // City
Console.WriteLine(parsedResponse.Addresses[0].AddressAlias); // Address Alias
Console.WriteLine(parsedResponse.Addresses[0].StreetAddress1); // Street Address1
Console.WriteLine(parsedResponse.Addresses[0].StreetAddress2); // Street Address2
Console.WriteLine(parsedResponse.Addresses[0].State); // State
Console.WriteLine(parsedResponse.Addresses[0].PostalCode); // Postal Code
Console.WriteLine(parsedResponse.Addresses[0].Nickname); // Nickname

Console.WriteLine(parsedResponse.Identities[0].IdentityNumber); // Identity Number
Console.WriteLine(parsedResponse.Identities[0].IdentityType); //

Console.WriteLine(parsedResponse.Emails[0].Email); // Email

Console.WriteLine(parsedResponse.Phones[0].Phone); // Phone
Console.WriteLine(parsedResponse.Phones[0].SmsConfirmationRequested); // SmsConfirmationRequested
Console.WriteLine(parsedResponse.Phones[0].SmsConfirmed); // SmsConfirmed
Console.WriteLine(parsedResponse.Phones[0].Primary); // Primary

Console.WriteLine(parsedResponse.Memberships[0].BusinessHandle); // BusinessHandle
Console.WriteLine(parsedResponse.Memberships[0].EntityName); // EntityName
Console.WriteLine(parsedResponse.Memberships[0].Role); // Role
Console.WriteLine(parsedResponse.Memberships[0].Details); // Details
Console.WriteLine(parsedResponse.Memberships[0].OwnershipStake); // OwnershipStake
Console.WriteLine(parsedResponse.Memberships[0].CertificationToken); // CertificationToken

Console.WriteLine(parsedResponse.Devices[0].AddedEpoch); // AddedEpoch
Console.WriteLine(parsedResponse.Devices[0].ModifiedEpoch); // ModifiedEpoch
Console.WriteLine(parsedResponse.Devices[0].Uuid); // Uuid




// Get Entity (business)           
response = api.GetEntity("business handle", "business private key");

// Success object response

Console.WriteLine(response.StatusCode); // 200
parsedResponse = (GetEntityResponse)response.Data;// Access to entity properties

Console.WriteLine(parsedResponse.Success); // Success
Console.WriteLine(parsedResponse.UserHandle); // User handle
Console.WriteLine(parsedResponse.EntityType); // Entity type
Console.WriteLine(parsedResponse.Entity); // Entity details
Console.WriteLine(parsedResponse.Addresses); // Addresses details
Console.WriteLine(parsedResponse.Identities); // Identities details
Console.WriteLine(parsedResponse.Emails); // Emails details 
Console.WriteLine(parsedResponse.Phones); // Phones 
Console.WriteLine(parsedResponse.Members); // Members list 

Console.WriteLine(parsedResponse.Entity.CreatedEpoch); // Created Epoch
Console.WriteLine(parsedResponse.Entity.Created); // Created
Console.WriteLine(parsedResponse.Entity.Birthdate); // Birthdate
Console.WriteLine(parsedResponse.Entity.EntityName); // Entity Name
Console.WriteLine(parsedResponse.Entity.LastName); // Last Name
Console.WriteLine(parsedResponse.Entity.FirstName); // First Name
Console.WriteLine(parsedResponse.Entity.BusinessUuid); // Business Uuid
Console.WriteLine(parsedResponse.Entity.BusinessType); // Business Type
Console.WriteLine(parsedResponse.Entity.NaicsCode); // Naics Code
Console.WriteLine(parsedResponse.Entity.NaicsCategory); // Naics Category
Console.WriteLine(parsedResponse.Entity.NaicsSubcategory); // Naics Sub category
Console.WriteLine(parsedResponse.Entity.BusinessWebsite); // Business Website
Console.WriteLine(parsedResponse.Entity.DoingBusinessAs); // Doing Business As

Console.WriteLine(parsedResponse.Addresses[0].Country); // Country
Console.WriteLine(parsedResponse.Addresses[0].City); // City
Console.WriteLine(parsedResponse.Addresses[0].AddressAlias); // Address Alias
Console.WriteLine(parsedResponse.Addresses[0].StreetAddress1); // Street Address1
Console.WriteLine(parsedResponse.Addresses[0].StreetAddress2); // Street Address2
Console.WriteLine(parsedResponse.Addresses[0].State); // State
Console.WriteLine(parsedResponse.Addresses[0].PostalCode); // Postal Code
Console.WriteLine(parsedResponse.Addresses[0].Nickname); // Nickname

Console.WriteLine(parsedResponse.Identities[0].IdentityNumber); // Identity Number
Console.WriteLine(parsedResponse.Identities[0].IdentityType); //

Console.WriteLine(parsedResponse.Emails[0].Email); // Email

Console.WriteLine(parsedResponse.Phones[0].Phone); // Phone
Console.WriteLine(parsedResponse.Phones[0].SmsConfirmationRequested); // SmsConfirmationRequested
Console.WriteLine(parsedResponse.Phones[0].SmsConfirmed); // SmsConfirmed
Console.WriteLine(parsedResponse.Phones[0].Primary); // Primary

Console.WriteLine(parsedResponse.Members[0].UserHandle); // User Handle
Console.WriteLine(parsedResponse.Members[0].FirstName); // First Name
Console.WriteLine(parsedResponse.Members[0].LastName); // Last Name
Console.WriteLine(parsedResponse.Members[0].Role); // Role
Console.WriteLine(parsedResponse.Members[0].Details); // Details
Console.WriteLine(parsedResponse.Members[0].OwnershipStake); // OwnershipStake

Console.WriteLine(parsedResponse.Devices[0].AddedEpoch); // AddedEpoch
Console.WriteLine(parsedResponse.Devices[0].ModifiedEpoch); // ModifiedEpoch
Console.WriteLine(parsedResponse.Devices[0].Uuid); // Uuid
  

Responses

Status Code

success Attribute

Description

200

true

Entity details were successfully returned in the response.

400

false

Bad request format - check validation_details for more information.

401

false

authsignature or usersignature header was absent or incorrect.


Did this page help you?