Check a person against your network

See how a single person is connected to your network members. Returns whether they’re a member and all connections to people in your network.

Cost: 1 credit.

Authentication

x-api-keystring
Your WealthAtlas API key. Contact support@wealthatlas.com to get started.

Path parameters

person_idstringRequired

Query parameters

min_strengthdoubleOptional0.45-1Defaults to 0.45
Minimum connection strength, which must be at least 0.45. Connections below that threshold are not stored because they represent relationships that we've determined are too weak to be useful.

Response

Successful Response
personobject or nullOptional
Profile. Null if the person ID was not found
in_networkbooleanOptionalDefaults to false
total_connectionsintegerOptionalDefaults to 0
max_strengthdoubleOptionalDefaults to 0
connectionslist of objectsOptional

Errors

402
Payment Required Error
422
Unprocessable Entity Error