Skip to main content
GET
/
api
/
engagements
/
card
/
onboarding
/
{onboarding-id}
Get onboarding
curl --request GET \
  --url https://partner-card.test.public.rockerapi.dev/api/engagements/card/onboarding/{onboarding-id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "eeb57fc6-729f-471e-ad6f-bbf3b03a2753",
  "status": "AWAITING_SIGNING",
  "additionalInformation": {
    "signingUrl": "https://example.com/sign"
  },
  "cardType": "CREDIT",
  "applicant": {
    "nationality": "DE",
    "salutation": "HERR",
    "firstName": "Hans",
    "lastName": "Müller",
    "phone": "+491701234567",
    "email": "[email protected]",
    "dateOfBirth": "1985-07-15",
    "placeOfBirth": "Berlin",
    "address": {
      "streetLine1": "Hauptstraße 10",
      "city": "Berlin",
      "postalCode": "10115",
      "country": "DE"
    },
    "employmentType": "PERMANENT",
    "civilStatus": "MARRIED",
    "monthlyIncome": {
      "currency": "EUR",
      "amount": 350000,
      "unit": "MINOR"
    },
    "housing": "OWNER",
    "locale": "de"
  },
  "createdAt": "2025-12-06T16:33:02.007636707Z",
  "updatedAt": "2025-12-06T17:33:02.007655067Z",
  "onboardingType": "INDIVIDUAL"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
onboarding-id
string<uuid>
required

Response

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
PROCESSING,
AWAITING_DOCUMENTS,
AWAITING_SIGNING,
AWAITING_DOCUMENT_REVIEW,
AWAITING_CARD_CREATION,
COMPLETED,
REJECTED,
FAILED
​
cardType
enum<string>
required
Available options:
CREDIT,
DEBIT,
PREPAID
​
applicant
HttpApplicant · object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
onboardingType
string
required
Allowed value: "INDIVIDUAL"
​
additionalInformation
CompletedOnboardingInformation · object
​
customerId
string<uuid>
​
metadata
Metadata · object

Key-value map. You can use metadata to store additional, structured information on an object. Max key length: 48 chars. Keys must not start with a digit. Max value length: 256 chars.