Company access / API reference

Start Login

Request and response reference for POST /api/auth/start.

POST/api/auth/start

Authentication: Unauthenticated

Use the base URL and access configuration provided to your institution. Examples are request templates, not transaction results. Field tables focus on client fields; preserve additional metadata returned by the configured service.

Request

This entry point does not require an existing session. Applicable onboarding, origin and verification policies still apply.

Request templatecURL

curl -X POST "$OSAI_CONSOLE_BASE_URL/api/auth/start" \
  -H "Content-Type: application/json" \
  -H "Origin: $OSAI_APP_ORIGIN" \
  --data '{
  "provider_id": "<provider_id>",
  "institution_id": "<institution_id>",
  "return_path": "<return_path>"
}'

Parameters

Name	Location	Requirement	Description
`Origin`	header · string	Required	Use the value defined for this resource.
`X-CSRF-Token`	header · string	Optional	Use the value defined for this resource.

Request body

Send JSON with Content-Type: application/json. Nested field names identify their parent object; required markers apply within that object. Replace template values using the relevant resource and configured instrument rules.

Field	Type	Description & constraints
`provider_id`Required in parent object	`string`	Defined by the resource contract.
`institution_id`Required in parent object	`string`	Defined by the resource contract.
`return_path`Required in parent object	`string`	Defined by the resource contract.
`invitation_token`Optional	`string`	Defined by the resource contract.

Responses

Inspect HTTP status before parsing a body. These tables describe client response fields rather than invented successful transaction payloads.

200 · HTTP 200 response

Field	Type	Description & constraints
`authorization_url`Required in parent object	`string`	Defined by the resource contract.
`expires_at`Required in parent object	`string`date-time	Defined by the resource contract.

400 · Invalid bounded instruction