> ## Documentation Index
> Fetch the complete documentation index at: https://docs.userecord.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get your credits

> The credits your organisation can spend on blue-collar campaigns, for the mode of your key (a test key reads the test wallet, a live key the live wallet), and what one candidate costs per verification method.

**Scope:** `credits:read`



## OpenAPI

````yaml /blue-collar-api/api-reference/openapi.json get /credits
openapi: 3.1.0
info:
  title: Record Blue Collar API
  version: 1.0.0
  description: >-
    Run Record candidate verification from your own system. You need two things:
    your **key id** and your **secret**. Everything else is generated. See
    Authentication for how.
servers:
  - url: https://api-bc.userecord.io/api/v1/partner
    description: Blue Collar API
security: []
tags:
  - name: Skills
    description: The skill taxonomy, read live a page at a time
  - name: Skill requests
    description: Ask Record to add a missing skill
  - name: Lookups
    description: >-
      Lookups for filling in a job mandate: places in India, the countries an
      abroad job can be in, and the employment types and shifts the playground
      offers
  - name: Workflows
    description: >-
      Your organisation's blue-collar workflows (read all; change and
      soft-delete only the ones you created)
  - name: Job mandates
    description: >-
      Your organisation's job mandates, addressed by Record's mandate_id (read
      and change all of them)
  - name: Campaigns
    description: Contact candidates for one of your jobs and verify them. Spends credits
  - name: Results
    description: >-
      What Record collected from each candidate: status (pending, completed,
      declined, failed) and an output of answers and verdicts
  - name: Analytics
    description: >-
      The workflow Overview analytics of the Record playground: funnel,
      channels, follow-ups, calls, drop-offs, languages (read-only, scope
      analytics:read)
  - name: Credits
    description: >-
      The credits your organisation can spend and where they were used
      (read-only, scope credits:read)
paths:
  /credits:
    get:
      tags:
        - Credits
      summary: Get your credits
      description: >-
        The credits your organisation can spend on blue-collar campaigns, for
        the mode of your key (a test key reads the test wallet, a live key the
        live wallet), and what one candidate costs per verification method.


        **Scope:** `credits:read`
      operationId: getCredits
      parameters: []
      responses:
        '200':
          description: The wallet of your key's mode
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - live
                          - test
                        description: >-
                          The mode of your API key: a test key is about your
                          test credits, a live key about your live credits
                      currency:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: 1 credit is 1 unit of this currency
                      account_status:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: >-
                          The state of your organisation's billing account; null
                          when there is none
                      billing_configured:
                        type: boolean
                        description: >-
                          false when your organisation has no billing account:
                          nothing can be sent until Record sets it up
                      wallet_configured:
                        type: boolean
                        description: >-
                          false when there is no wallet for this mode, for
                          example test credits that were never set up. A
                          campaign in this mode is refused until Record adds
                          them
                      wallet:
                        anyOf:
                          - type: object
                            properties:
                              granted:
                                type: number
                                description: Credits added to this wallet in all
                              consumed:
                                type: number
                                description: Credits used from it in all
                              balance:
                                type: number
                                description: 'Credits left: what a campaign can spend now'
                          - type: 'null'
                        description: null when wallet_configured is false
                      prices:
                        type: array
                        items:
                          type: object
                          properties:
                            service:
                              type: string
                              enum:
                                - skill_verification
                                - data_enrichment
                            label:
                              type: string
                            unit_price:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: >-
                                Credits charged for one candidate. null: no
                                price is set for your organisation, and a
                                campaign that needs this method is refused
                        description: What one candidate costs for each verification method
              example:
                success: true
                data:
                  mode: live
                  currency: INR
                  account_status: active
                  billing_configured: true
                  wallet_configured: true
                  wallet:
                    granted: 50000
                    consumed: 18250
                    balance: 31750
                  prices:
                    - service: skill_verification
                      label: Scenario questions
                      unit_price: 25
                    - service: data_enrichment
                      label: Enrichment
                      unit_price: 5
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: pcall GET "/api/v1/partner/credits"
        - lang: javascript
          label: JavaScript
          source: |-
            const res = await call("GET", "/api/v1/partner/credits");
            const { data } = await res.json();
        - lang: python
          label: Python
          source: |-
            res = call("GET", "/api/v1/partner/credits")
            data = res.json()["data"]
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.
    SecretKey:
      type: apiKey
      in: header
      name: x-secret-key
      description: >-
        Your secret, `VFN_SK_…`. **Not a real header, and never sent to the
        API.** It is only a form field for Try it, which uses it to sign your
        request in your browser. In your own code you sign each request with the
        secret and send `x-api-key`, `x-timestamp` and `x-signature` (see
        Authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.