> ## Documentation Index > Fetch the complete documentation index at: https://docs.reechee.io/llms.txt > Use this file to discover all available pages before exploring further. # Unlock a contact (1 credit) > Reveal the reviewer's (or a buying-committee member's) email or phone for an opportunity, via live enrichment. **Spends 1 credit** on a successful reveal; if no contact is found the credit is refunded and `found` is `false`. Requires a **spend budget** on the credential (`403` otherwise): a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. For a committee member, set `target: committee` and `target_id` (the member's index from `get_opportunity`). ## OpenAPI ````yaml /openapi.yaml post /opportunities/{id}/unlock-contact openapi: 3.1.0 info: title: Reechee Developer Platform API version: 1.0.0 description: > The Reechee REST API exposes software-review pain points, buying signals, and sales opportunities. Two auth lanes share one base URL: - **Anonymous** (no key) - read-only, IP rate-limited. Product search, a free pain-points taste, and category competitors. - **API key** (`Authorization: Bearer rch_live_…`) - paid teams get full pain-point reports, opportunities, watchlist, credit balance, and safe write actions (follow/unfollow, triage). Every response uses a consistent envelope: `{ "success": true, "data": … }` on success (with an optional `meta`), or `{ "success": false, "error": { "code", "message", "details"? } }` on failure. contact: name: Reechee url: https://reechee.io servers: - url: https://app.reechee.io/api/v1 description: Production security: [] tags: - name: System description: Health and connectivity. - name: Products description: Search products and read their pain points and competitors. - name: Opportunities description: Read and triage sales opportunities (API key required). - name: Watchlist description: Read and manage the team's followed products (API key required). - name: Account description: Team account data such as credit balance (API key required). - name: Credits description: >- Credit-spending actions (Tier 3). Requires a spend budget on the credential - a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. paths: /opportunities/{id}/unlock-contact: post: tags: - Credits summary: Unlock a contact (1 credit) description: > Reveal the reviewer's (or a buying-committee member's) email or phone for an opportunity, via live enrichment. **Spends 1 credit** on a successful reveal; if no contact is found the credit is refunded and `found` is `false`. Requires a **spend budget** on the credential (`403` otherwise): a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. For a committee member, set `target: committee` and `target_id` (the member's index from `get_opportunity`). operationId: unlockContact parameters: - $ref: '#/components/parameters/OpportunityId' requestBody: required: true content: application/json: schema: type: object required: - field properties: field: type: string enum: - email - phone target: type: string enum: - reviewer - committee default: reviewer target_id: type: integer description: Committee member index (required when target is committee). examples: reviewer_email: value: field: email committee_phone: value: field: phone target: committee target_id: 0 responses: '200': description: > The reveal result. `found: true` with the value when a contact was found (a credit was spent), or `found: false` when none exists (no credit kept). content: application/json: schema: type: object required: - success - data properties: success: type: boolean const: true data: $ref: '#/components/schemas/UnlockContactResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/SpendCapRequired' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: OpportunityId: name: id in: path required: true description: Opportunity id (uuid). schema: type: string format: uuid schemas: UnlockContactResponse: type: object required: - field - target - found - value - source - credits_remaining properties: field: type: string enum: - email - phone target: type: string enum: - reviewer - committee found: type: boolean description: True when a contact was found (a credit was spent). value: type: - string - 'null' description: The email or phone when found, else null. source: type: - string - 'null' description: Enrichment source (e.g. Prospeo, Cache) when found. credits_remaining: type: integer from_cache: type: boolean description: Present and true when served from the enrichment cache. already_revealed: type: boolean description: Present and true when previously unlocked (no charge). reason: type: string description: >- When `found` is false, why (e.g. no_linkedin_url, enrichment_failed, service_unavailable, already_revealed). credit_refunded: type: boolean description: >- Present, and false, only in the rare case where a not-found reveal charged a credit that the refund then failed to return. `credits_remaining` reflects the charge. Absent otherwise. ErrorResponse: type: object required: - success - error properties: success: type: boolean const: false error: type: object required: - code - message properties: code: type: string enum: - invalid_request - unauthorized - payment_required - forbidden - not_found - rate_limited - internal_error message: type: string details: type: - object - 'null' additionalProperties: true responses: BadRequest: description: The request was malformed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: invalid_request message: Invalid request Unauthorized: description: A valid API key is required (or the key was invalid/revoked/expired). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: unauthorized message: API key required PaymentRequired: description: > The credit-spending call was blocked for payment reasons. `details.reason` distinguishes the two cases: - `spend_cap_reached` - the credential's rolling 30-day spend budget (per-key cap, or an OAuth connection's credit budget) would be exceeded; carries `spend_cap`, `spend_used`, `spend_remaining`, `credits_required`. - `out_of_credits` - the team's credit balance is too low; carries `credits_required` and `credits_remaining`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: payment_required message: API key spend cap reached details: reason: spend_cap_reached spend_cap: 100 spend_used: 100 spend_remaining: 0 credits_required: 1 SpendCapRequired: description: > The credential has no spend budget. Credit-spending (Tier 3) actions require one as a safety guardrail - for API keys, set a per-key spend cap in Settings → API keys; for OAuth connections, reconnect and allow a credit budget on the consent screen. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: forbidden message: >- This API key has no spend cap. Set a per-key spend cap in Settings to enable credit-spending tools. details: reason: spend_cap_required NotFound: description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: not_found message: Resource not found RateLimited: description: | The rate limit was exceeded. The response carries `Retry-After` and `X-RateLimit-*` headers. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer X-RateLimit-Limit: description: Requests allowed in the window. schema: type: integer X-RateLimit-Remaining: description: Requests remaining in the window. schema: type: integer X-RateLimit-Reset: description: Unix seconds when the window resets. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: rate_limited message: Rate limit exceeded details: retry_after_seconds: 12 limit: 60 remaining: 0 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: rch_live_… description: > A paid-team API key, sent as `Authorization: Bearer rch_live_…`. Create and revoke keys in the app under Settings → API keys. ````