Get Onboarding

get/recipients/{recipient_id}/onboardings/{onboarding_id}

Request

Base URL
https://api-sandbox.y.uno/v1
Auth
API key in header PUBLIC-API-KEY and API key in header PRIVATE-SECRET-KEY
TypeScript
https://skmtc.dev/y/apis/ai-caller/docs/recipients/:recipient_id/onboardings/:onboarding_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

recipient_idstring required

ID of the recipient

onboarding_idstring required

ID of the onboarding to retrieve

Response

Onboarding details retrieved successfully

idstring

The unique identifier of the onboarding

account_idstring

Unique id of the account in Yuno

recipient_idstring

The unique identifier of the recipient

type'PREVIOUSLY_ONBOARDED' | 'ONE_STEP_ONBOARDING' | 'TWO_STEP_ONBOARDING'

Type of onboarding flow

workflow'HOSTED_BY_PROVIDER' | 'HOSTED_BY_YUNO' | 'DIRECT'

Workflow of the onboarding

statusstring

Current status of the onboarding

callback_urlstring uri

URL to redirect after the onboarding process

created_atstring date-time

Onboarding creation date

updated_atstring date-time

Onboarding last update date

Example response

{
  "id": "104911d-5df9-429e-8488-ad41abea1a4b",
  "account_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
  "recipient_id": "9104911d-5df9-429e-8488-ad41abea1a4b",
  "type": "PREVIOUSLY_ONBOARDED",
  "workflow": "HOSTED_BY_PROVIDER",
  "status": "ACTIVE",
  "callback_url": "https://www.google.com",
  "provider": {
    "id": "PAGARME",
    "connection_id": "104911d-5df9-429e-8488-ad41abea1a4b",
    "recipient_id": "AAAAA01"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.