Crystal Developer API

# Overview Crystal is the world's most trusted, validated, and accurate source of contact-level personality data. Thousands of organizations globally use our software tools to understand behavior and improve communication across their sales, training, and management processes. Our Personality API allows developers to integrate Crystal's industry-leading personality data into any software application or internal system. We provide two main endpoints: _**Profiles**_ The _Profile_ endpoint allows you to search Crystal's global database of personality profiles by email address, social media URL, and other unique identifiers. It is commonly used for: - Enriching CRM records with personality data. - Building personality-based features into other people-centric software products. - Customer persona-building and segmentation. _**Analysis**_ The _Analysis_ endpoint allows you to use Crystal's predictive engine to generate new personality profiles from your own text samples and metadata. It is commonly used for: - Analyzing resumes, bios, summaries, and other text samples. - Generating high-volume personality profiles from contact lists that already have associated metadata. - Analyzing job descriptions, emails, and other messaging to determine style. # Authentication The API is available to Crystal Enterprise customers, and each customer has a unique API token. If you do not know your token, please contact your Crystal Customer Success Manager. Every request requires this header: _Authorization: Bearer YOUR_TOKEN_ # Error Codes You may experience the following error codes: - **401 Unauthorized:** This means your token does not have access to the endpoint you are attempting to use. - **402 Payment Required:** This means you have exceeded your monthly profile limit, or you have not yet activated your enterprise account. - **404 Not Found:** This means Crystal could not find a matching profile based on the query parameters provided. # FAQ #### Where does Crystal's data come from? Crystal creates DISC-based personality profiles by analyzing publicly-available data, often aggregate from public web pages via a third-party data partner. Crystal users may also publish their own assessment results to provide maximum accuracy. Our analysis engine is trained and re-trained on thousands of anonymized, validated personality assessment results. We use a statistical, probabalistic approach to personality predictions, mapping out the correlations between specific traits and factual attributes like job titles, industries, skills, interests, and word choices. #### How should Crystal's data be used? Crystal's API and dataset is intended to be used for interpersonal communication, personal development, and training purposes. This often translates well into sales, marketing, and leadership use cases. This data is not intended to be used for hiring, candidate selection, credit reporting, or other decision-making purposes that may materially impact the data subject. #### How can I get full access to the API? Crystal's API is available to approved partners with an annual agreement. For more information, please contact [[email protected]](mailto:[email protected]).