Retrieving your JourneyIds and ActorIds

Created by Kevin Smith, Modified on Mon, 18 Mar, 2024 at 7:09 AM by Kevin Smith


The GET /api/v2/ci/journeys endpoint will return a list of all the Journeys that you have available to use (based on the API Key you are using).  Each Journey in the list will contain the following details:


{

    "id": "xxx",

    "title": "xxx",

    "description": "xxx",

    "endUserDescription": "xxx",

    "isPublic": false,

    "isActive": true,

    "webhookEnabled": false,

    "actors": [

      {

        "id": xx,

        "title": "xxx",

        "canAddMultiple": false,

        "isClient": false

      }

    ],

    "industries": [],

    "method": 0,

    "stepTypes": [

      1,

      2,

      11

    ],

    "showAllSummaryPages": true,

    "showIntroSummaryPage": true,

    "showJourneyDescriptionPage": false,

    "isRightToWork": false,

    "isRightToRent": false,

    "isSafeHarbour": false,

    "isAffordability": false

  }


The two highlighted values are important.  The first "id" is the journeyId, the second "id" (within the "actors" section) is the actorID.


Both journeyId and actorId will be required in order to create a new Process.


NOTE: Journeys can be configured with multiple actors - e.g. 'House Buyer' and 'House Seller' where multiple role types are required.  However, in the vast majority of cases, and for all public journeys, only one Actor is used.




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule