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

# Get Journey State



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/partner/journey/{journeyId}
openapi: 3.1.0
info:
  title: EASYCRED Partner API
  version: 1.0.0
  description: >-
    EASYCRED-managed secure partner API. All requests require a Bearer API key
    plus HMAC request signing (X-Signature / X-Timestamp / X-Nonce). No raw
    customer PII is exposed by this version. Signing convention: the HMAC-SHA256
    is computed over method, path, timestamp, nonce and the raw request body.
    For GET requests (and any request with no body) the body component is the
    EMPTY string '' — sign over '' for those requests.
servers:
  - url: https://api.easycred.in
    description: Production
security:
  - bearerAuth: []
paths:
  /api/v1/partner/journey/{journeyId}:
    get:
      summary: Get Journey State
      parameters:
        - name: X-Signature
          in: header
          required: true
          description: >-
            HMAC-SHA256 signature over method, path, timestamp, nonce and raw
            body.
          schema:
            type: string
        - name: X-Timestamp
          in: header
          required: true
          description: >-
            Unix epoch seconds. Requests outside the tolerance window are
            rejected.
          schema:
            type: string
        - name: X-Nonce
          in: header
          required: true
          description: Unique per-request nonce. Replays are rejected.
          schema:
            type: string
        - name: journeyId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JourneyStateResponse'
        '401':
          description: >-
            Authentication failed (missing/invalid key, signature, or replayed
            nonce).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Authenticated but missing the required scope / product access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth:
            - leads:status:read
components:
  schemas:
    JourneyStateResponse:
      type: object
      description: >-
        Mirrored journey view (offers, selectedOffer, nextAction, outcome).
        Read-only off our DB.
      properties:
        success:
          type: boolean
          const: true
        data:
          $ref: '#/components/schemas/JourneyView'
      required:
        - success
        - data
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
      required:
        - success
        - error
    JourneyView:
      type: object
      description: >-
        Mirrored journey state. Read-only off our DB; never exposes raw customer
        PII.
      properties:
        journeyId:
          type: string
        productCode:
          type: string
        channel:
          type: string
          example: API_HEADLESS
        currentNextAction:
          $ref: '#/components/schemas/NextAction'
        offers:
          type: array
          description: >-
            Lender offers. On a gold journey at SELECT_GOLD_LOAN_BRANCH, each
            offer carries branchLocations[].
          items:
            $ref: '#/components/schemas/JourneyOffer'
        selectedOffer:
          type: object
          additionalProperties: true
          description: The offer the customer selected, if any.
        outcome:
          type: string
          description: Terminal outcome (e.g. COMPLETED, REJECTED), if reached.
        pollIntervalSeconds:
          type:
            - integer
            - 'null'
          description: Suggested poll cadence for the current POLL step.
      required:
        - journeyId
        - productCode
        - channel
        - currentNextAction
        - offers
    NextAction:
      type: object
      description: >-
        The mirrored next step the client must drive (POLL / REDIRECT / COLLECT
        / TERMINAL).
      properties:
        type:
          type: string
          description: >-
            e.g. POLL_FOR_OFFERS, SELECT_OFFER, SUBMIT_BANK_DETAILS,
            REDIRECT_TO_KYC, COMPLETED.
        category:
          type: string
          enum:
            - POLL
            - REDIRECT
            - COLLECT
            - TERMINAL
      required:
        - type
    JourneyOffer:
      type: object
      description: >-
        A lender offer mirrored from the journey. Fields beyond those listed may
        be present (passed through from the lender) — rely only on the
        documented ones.
      properties:
        offerId:
          type: string
        sellerName:
          type: string
          description: Lender / seller display name.
        principalAmount:
          type: number
        emiAmount:
          type: number
        tenure:
          type: number
          description: Tenure in months.
        interestRate:
          type: number
        apr:
          type: number
        processingFees:
          type: number
        netDisbursedAmount:
          type: number
        minimumLoanAmount:
          type: number
        kfsLink:
          type: string
          description: Key Fact Statement link.
        branchLocations:
          type: array
          description: >-
            Present on gold-loan offers at the SELECT_GOLD_LOAN_BRANCH step.
            Pick one and send its `id`.
          items:
            $ref: '#/components/schemas/BranchLocation'
      required:
        - offerId
    BranchLocation:
      type: object
      description: >-
        A gold-loan branch the customer can collateralise at. Echo the `id` back
        as the `branchLocationId` in a SELECT_GOLD_LOAN_BRANCH action.
      properties:
        id:
          type: string
          description: Send this back as `branchLocationId` on SELECT_GOLD_LOAN_BRANCH.
        branchName:
          type: string
          example: Ahmedabad - Panchvati
        address:
          type: string
          description: Full postal address (city/state are embedded here).
        latitude:
          type: number
        longitude:
          type: number
        isSelected:
          type: boolean
          description: Whether this branch is already the selected one.
      required:
        - id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key of the form ec_(live|test)_<prefix>_<secret>. Scopes are listed
        per operation.

````