---
title: "Get Status"
method: GET
path: "/v1/onboarding/{id}"
tags: ["Onboarding Services"]
---

# Get Status

`GET /v1/onboarding/{id}`

## Request

- Base URL: `https://api-sandbox.koin.com.br`
- URL: `https://api-sandbox.koin.com.br/v1/onboarding/{id}`
- Auth: none declared

API to get the status of the onboarding

## Path parameters

- `id` string, required

## Query parameters

- `field` 'ONBOARDING_ID' | 'REFERENCE_ID'

## Response `200`

Antifraud analysis status response

- StandardApiResponse
  - `onboardingId` string, required: Onboarding identification
  - `referenceId` string, required: Client transaction identifier
  - `status` 'PENDING' | 'INPROGRESS' | 'ACTIONREQUIRED' | 'COMPLETED' | 'REJECT' | 'CANCELLED', required: Onboarding status
  - `message` string: Information message
  - `credentials` Credentials
    - `storeCode` string, required: Store code
    - `privateKey` string: Authentication key
    - `orgId` string: Fingerprint key
  - `paymentAccounts` PaymentAccount[]
    - `paymentMethod` 'CARD': Payment method for the extract
    - `account` string: Payment account number
    - `evaluatesFraud` boolean: Indicates if the account has antifraud

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/koin/apis/onboarding-api.md) - [All operations](https://skmtc.dev/koin/apis/onboarding-api/llms.txt) - [OpenAPI document](https://skmtc.dev/koin/apis/onboarding-api/revisions/5adb79153066?raw)