User Portal API

To grant a user access to a portal, the Integrator uses the Portals API to retrieve a special Portal Access URL. The integrator can then either redirect the end-user to the Portal Access URL or render a page that contains an iframe pointing to Portal Access URL. Please see the Embedding section for more information about using iframes.

Under no circumstances is the Integrator's platform permitted to fetch the contents of the Portal Access URL. The Portal Access URLs may only be accessed by the end-user's browser.

The URL obtained by the API has a few important characteristics:

it is one time use
it expires in 60 seconds
it is unique to the user and the portal they wish to enter and cannot be manipulated by the end-user
it is self-authenticated meaning the end-user’s browser does not need API keys to follow it

user_id integer, required	The User we are launching the portal for. If we are launching the Applicant portal, this would be the `user_id` of the Applicant.
report string, required, po portal only	Can be `credit`, `background`, or `both`. Indicates which report(s) you wish to display.
applicant_id integer, required, po portal only	The `id` of the User (Applicant) whose report we are viewing. CreditConnect will verify the Property Owner (indicated by `user_id`) can view the Applicant's report (indicated by `applicant_id`).

POST

/api/v1/portals/kba

Creates a special Portal Access URL for the user indicated and returns the URL.

Example KBA Portal Request

{
  "user_id": 1
}

Example Response

{
  "url": "https://creditconnect.instascreen.net/portal/abc123..."
}

Example Error Response

{
  "errors": {
    "general": "Could not find user"
  }
}

POST

/api/v1/portals/applicant

Example Applicant Portal Request

{
  "user_id": 1
}

Example Response

{
  "url": "https://creditconnect.instascreen.net/portal/abc123..."
}

Example Error Response

{
  "errors": {
    "general": "Could not find user"
  }
}

POST

/api/v1/portals/po

Example Property Owner Portal Request

{
  "user_id": 1,
  "report": "credit",
  "applicant_id": 2
}

Example Response

{
  "url": "https://creditconnect.instascreen.net/portal/abc123..."
}

Example Error Response

{
  "errors": {
    "general": "Could not find user"
  }
}