What resources are available for me to get the WE API setup quickly?
Documentation – online and available on the public facing site.
Examples – provides insight into some examples/ use cases for the API.
Sandbox – allows access to test the API and make sample calls with dummy data.
Platform Health Status – provides a status of the actual API in a stoplight fashion.
Management Dashboard – allows greater insight into how often they are using the API.
What data is returned through the API?
The WE API has two possible profile calls (Basic Profile & Full Profile) that may be made and return different values.
Basic Profile fields include: full name, age, gender, and primary address. Our primary ratings and scores, such as: Net Worth, Income, Real Estate Total Value, Accredited Investor, Real Estate – # of Properties, Estimated Annual Donations, P2G Score, and Gift Capacity will also be included.
Full Profile fields include: full name, age, gender, and primary address, marital status. Demographic and relationship information is also included such as; has children, spouse full name. Ratings and scores, such as: Net Worth, Income, Total Assets, Cash on Hand, Business Ownership, Business Sales Volume, Total Stock, Direct Stock Holdings, Indirect Stock Holdings, Investable Assets, Organization Type, Vehicle Ownership, Board Member, Real Estate Total Value, Accredited Investor, Real Estate – # of Properties, Total Pensions, Estimated Annual Donations, P2G Score, Affiliation Inclination, Planned Giving, Charitable Donations, Total Political Donations, and Gift Capacity will also be included.
|Basic Profile Fields||Sample Basic Profile Values|
|Full Name||Bill Jones|
|Primary Address – Personal||12345 Whirling Way, Kealakekua, HI, 96750|
13 possible values:
6 possible values:
|Real Estate Total Value||
9 possible values:
|Accredited Investor||True — or — False|
|Real Estate – # of Properties||2|
|Estimated Annual Donations||
8 possible values:
|Propensity to Give (P2G) Score||
A descriptive label for the Propensity to Give (P2G) combo score that is determined by the first digit in the P2G.
5 possible descriptive values:
21 possible values:
What are the capabilities of the API?
We’ve worked hard to keep the WE API really simple but powerful. There are just a few endpoints to know.
The WE API may be called by multiple input values including; Name and Address, Email Address, and Phone Number.
|API Call||Required Input||Optional Input||Returned|
|/v1/profile/find_one/by_address/basic||Name, Address||Profile attribute based on type requested|
|/v1/profile/find_one/by_email/basic||Email Address||Name||Profile attribute based on type requested|
|/v1/profile/find_one/by_phone/basic||Phone Number||Name||Profile attribute based on type requested|
|/v1/profile/session/create||Logs app in and returns session ID|
How do I access the Sandbox for the API?
The sandbox can be accessed through the developers’ site which is publically available for developers to access whether they have purchased the WE API or not. This may be accessed through the site: dev.wealthengine.com.
How does the API authentication and security work?
A user may register for the WE API by creating a login. Once logged into the developers’ site a developer may create, view and edit their API Keys for access to the sandbox. Any API Keys created will be provisioned only to their account. We then use API Keys to authenticate.
All requests must be https:// and authenticated. Valid authentication methods are:
• API Key
• Session Key
This unique identifier sometimes referred to as a bearer token can be used to secure all requests. API Keys should be kept secure as they are equivalent to a login and password.
In some scenarios like web browsers, exposing the raw API Key might be a security risk. Any API Key can be used by a secure server to create a temporary Session Key which can be safely sent to and used by the web browser in place of the API Key. The lifespan of a Session Key is set when it is created. The default expiration is one hour (3600 seconds) from the time of creation. To create a new temporary Session Key, call /v1/session/create with a valid API Key.
How many calls can I make? What are the rate limits?
A user may make up to 600 calls per minute. Further details will depend on their set plan.
Daily/monthly limits depend on your plan
Response time: < 1s
Will I get a match on every API call I make?
When you call our API, we do a lookup in our national database. We do not have every name/address, email, and phone so, there will be times when you call the API and don’t get anything back. Because we have differing amount of data coverage with name/address, email, and phone, match rates will vary depending on the piece of information you are using name/address, email, or phone to perform the lookup. We are continuously enhancing our data so, our match rates are always getting better.
Our current match rates are approximately:
By name/address: 90%
By email: 20%
By phone: 20%
What’s next on the road map for the API? When? What is the roadmap?
We are continuously working to improve the API and add capabilities. Our roadmap includes a number of significant enhancements coming in the next few months including the ability to create prospect lists and the ability to look up a list of people through a batch call.
What support is available for the WE API?
On the public site of for our WE API we’ve made documentation available so questions may be easily addressed. We suggest you review the provided documentation and FAQ first before contacting WE for support. Once registered and logged into the developers’ site you may access the support page which will also direct you to documentation, the FAQ and allow you to submit a ticket for our support staff.
How do I contact WE for support related to the API?
If you have a question or need further assistance that is not available through our documentation you may submit a ticket to our support team from within the developers’ support page.
On that page you’ll see an area to contact us for additional help. Simply enter your name, email and details about your issue. Once submitted, your ticket will be received by our support team and someone will be in touch.
How do I report a bug with the API or documentation?
Initially we will not have a designated area within the developers’ site to report a bug. Any errors with documentation or bugs may be submitted through the support process by submitting an issue for our support team. These will then be routed to our engineers to resolve.
How do you buy the WE API?
Our developers’ site enables you to sign up, try out, and develop against our sandbox for free. When you are ready to upgrade to production API access, simply contact us.
How is the WE API priced?
The WE API is priced so that you pay for what you get. Every time you call the API, we do a match against our nationwide database. You will be charged for each profile that is returned not for each call. This is due to the fact that sometimes you won’t get a result because we may not be able to match to a certain name/address, email, or phone number. We have a range of plans that allow you to buy just the volume you need. The higher the volume you purchase, the greater the discount.
How will billing work? Is there overage?
You will be billed for your plan when you upgrade to production access.
Our plans do not have overage. If your usage exceeds the plan limits, the API endpoint will stop delivering data and you’ll need to contact us to purchase additional capacity.
The returned data in each call will tell you how many calls you have remaining with your plan.