curl --request POST \
--url https://partner-card.test.public.rockerapi.dev/api/v5/engagements/card/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"cardType": "CREDIT",
"requestedCreditLimit": {
"currency": "EUR",
"amount": 100000,
"unit": "MINOR"
},
"applicant": {
"nationality": "DE",
"salutation": "HERR",
"firstName": "Hans",
"lastName": "Müller",
"phone": "+491701234567",
"email": "hans.mueller@example.com",
"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": "EUR",
"unit": "MINOR"
},
"approvedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
},
"engagementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}<string>{
"code": "<string>",
"message": "<string>"
}Card
General onboarding (in development)
In development: the request can still change without notice. Use v4 to onboard customers until v5 is released.
POST
/
api
/
v5
/
engagements
/
card
/
onboarding
curl --request POST \
--url https://partner-card.test.public.rockerapi.dev/api/v5/engagements/card/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"cardType": "CREDIT",
"requestedCreditLimit": {
"currency": "EUR",
"amount": 100000,
"unit": "MINOR"
},
"applicant": {
"nationality": "DE",
"salutation": "HERR",
"firstName": "Hans",
"lastName": "Müller",
"phone": "+491701234567",
"email": "hans.mueller@example.com",
"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": "EUR",
"unit": "MINOR"
},
"approvedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
},
"engagementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}<string>{
"code": "<string>",
"message": "<string>"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
- HttpCardOnboardingRequestV5Business
- HttpCardOnboardingRequestV5Consumer
- HttpCardOnboardingRequestV5Corporate
- HttpCardOnboardingRequestV5Supplementary
Available options:
CREDIT, DEBIT, PREPAID Money object represented in the smallest currency unit
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Allowed value:
"BUSINESS"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
Show child attributes
Response
Available options:
PROCESSING, AWAITING_DOCUMENTS, AWAITING_SIGNING, AWAITING_DOCUMENT_REVIEW, AWAITING_MANUAL_REVIEW, AWAITING_CARD_CREATION, COMPLETED, REJECTED, FAILED - HttpAdditionalInformationCompletedOnboardingInformation
- HttpAdditionalInformationCreditInformation
- HttpAdditionalInformationFailureInformation
- HttpAdditionalInformationRejectInformation
- HttpAdditionalInformationSigningInformation
Show child attributes
Show child attributes