General onboarding with extended company types

curl --request POST \ --url https://partner-card.test.public.rockerapi.dev/api/v4/engagements/card/onboarding \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "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" }, "redirectUrls": { "successUrl": "https://example.com/success", "failUrl": "https://example.com/fail" }, "onboardingType": "CONSUMER" } '

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PROCESSING",
  "createdAt": "2023-11-07T05:31:56Z",
  "additionalInformation": {
    "creditAssessment": {
      "approvedLimit": {
        "amount": 123,
        "currency": "<string>",
        "unit": "<string>"
      },
      "approvedAt": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    },
    "engagementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

POST

api

engagements

card

onboarding

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "PROCESSING",
  "createdAt": "2023-11-07T05:31:56Z",
  "additionalInformation": {
    "creditAssessment": {
      "approvedLimit": {
        "amount": 123,
        "currency": "<string>",
        "unit": "<string>"
      },
      "approvedAt": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z"
    },
    "engagementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Business
Consumer

cardType

enum<string>

required

Available options:

CREDIT,

DEBIT,

PREPAID

applicant

HttpApplicantV2 · object

required

Show child attributes

applicant.nationality

string

required

ISO 3166-1 alpha-2 country code

applicant.salutation

enum<string>

required

Available options:

HERR,

FRAU,

MR,

MRS,

MS,

MISS

applicant.firstName

string

required

applicant.lastName

string

required

applicant.phone

string

required

E.164 format.

applicant.email

string

required

applicant.dateOfBirth

string

required

ISO 8601 (YYYY-MM-DD)

applicant.placeOfBirth

string

required

applicant.address

HttpOnboardingAddress · object

required

Show child attributes

applicant.address.streetLine1

string

required

applicant.address.city

string

required

applicant.address.postalCode

string

required

applicant.address.country

enum<string>

required

ISO 3166-1 alpha-2 country code

Available options:

DE

applicant.address.streetLine2

string

applicant.employmentType

enum<string>

required

Available options:

PERMANENT,

SOLE_PROPRIETOR,

RETIRED,

STUDENT,

HOMEMAKER,

OTHER

applicant.civilStatus

enum<string>

required

Available options:

SINGLE,

MARRIED,

COHABITANT,

DIVORCED,

WIDOWED

applicant.monthlyIncome

object

required

Money object represented in the smallest currency unit

Show child attributes

applicant.monthlyIncome.amount

integer<int64>

required

applicant.monthlyIncome.currency

string

required

applicant.monthlyIncome.unit

string

required

applicant.housing

enum<string>

required

Available options:

RENTING,

OWNER,

OTHER

applicant.locale

enum<string>

required

ISO 639-1 language code (de, en)

Available options:

de,

en

applicant.verifiedPhone

string

E.164 format.

applicant.externalCustomerId

string

company

HttpCompanyV3 · object

required

Show child attributes

company.name

string

required

company.city

string

required

company.registrationInfo

Freelancer · object

required

Show child attributes

company.registrationInfo.taxNumber

string

required

company.registrationInfo.registrationDate

string

required

ISO 8601 (YYYY-MM-DD)

company.registrationInfo.mainActivity

HttpBusinessActivity · object

required

Show child attributes

company.registrationInfo.mainActivity.code

enum<string>

required

Nace 2.1 section code

Available options:

A,

B,

C,

D,

E,

F,

G,

H,

I,

J,

K,

L,

M,

N,

O,

P,

Q,

R,

S,

T,

U,

V

company.registrationInfo.mainActivity.classification

enum<string>

required

Available options:

NACE_REV_2_1

company.registrationInfo.countryCode

enum<string>

required

ISO 3166-1 alpha-2 country code

Available options:

DE

company.registrationInfo.businessType

string

required

Allowed value: "FREELANCER"

redirectUrls

HttpRedirectUrls · object

required

Show child attributes

redirectUrls.successUrl

string

required

redirectUrls.failUrl

string

required

onboardingType

string

required

Allowed value: "BUSINESS"

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.

Show child attributes

metadata.{key}

string

Metadata value

Response

string<uuid>

required

status

enum<string>

required

Available options:

PROCESSING,

AWAITING_DOCUMENTS,

AWAITING_SIGNING,

AWAITING_DOCUMENT_REVIEW,

AWAITING_CARD_CREATION,

COMPLETED,

REJECTED,

FAILED

createdAt

string<date-time>

required

additionalInformation

CompletedOnboardingInformation · object

CompletedOnboardingInformation
CreditInformation
FailureInformation
RejectInformation
SigningInformation

Show child attributes

additionalInformation.creditAssessment

HttpCreditAssessment · object

required

Show child attributes

additionalInformation.creditAssessment.approvedLimit

object

required

Money object represented in the smallest currency unit

Show child attributes

additionalInformation.creditAssessment.approvedLimit.amount

integer<int64>

required

additionalInformation.creditAssessment.approvedLimit.currency

string

required

additionalInformation.creditAssessment.approvedLimit.unit

string

required

additionalInformation.creditAssessment.approvedAt

string<date-time>

required

additionalInformation.creditAssessment.validUntil

string<date-time>

required

additionalInformation.engagementId

string<uuid>

required

General onboarding with extended company types Individual onboarding

⌘I

Getting started

API

General onboarding with extended company types

Authorizations

Body

Response