Create a Consumer

POST /obp/v7.0.0/my/consumers

OBPv5.1.0-createMyConsumer No role required Consumer

Create a Consumer (Authenticated access).

redirect_url must meet the redirect URL rules (https; http only for localhost; or an app scheme in reverse-domain form; no wildcard, user information or fragment). On this instance a redirect URL may point to any host that meets the redirect URL rules. See here

If this Consumer is for an app your installation runs itself (such as the Portal, the API Manager, Opey or a monitoring service like OBP-Sentinel) and the app calls OBP with its own application token (OAuth2 client credentials, no User), those calls need Roles granted to the Consumer as Scopes. Have an administrator mark the Consumer as a Platform App (POST /obp/v7.0.0/management/platform-apps); the app then declares the Scopes it needs (PUT /obp/v7.0.0/consumers/current/platform-app), retrying until it is marked, and the administrator grants the missing ones. See here

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON request body fields (9)

app_name: appNameBank
app_type: Web
company: Tesobe GmbH
description: Description of the object. Maximum length is 2000. It can be any characters here.
developer_email
enabled: false
redirect_url: https://apisandbox.openbankproject.com
client_certificate: client_certificate
logo_url: logo_url

JSON response body fields (24)

app_name: appNameBank
app_type: Web
certificate_pem: certificate_pem
company: Tesobe GmbH
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
consumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
created
created_by_user
description: Description of the object. Maximum length is 2000. It can be any characters here.
developer_email
email: felixsmith@example.com
enabled: false
issuer_domain_name: issuer_domain_name
not_after: not_after
not_before: not_before
provider: ETHEREUM
provider_id
redirect_url: https://apisandbox.openbankproject.com
subject_domain_name: subject_domain_name
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
certificate_info: certificate_info
logo_url: logo_url
roles_info: roles_info

Example request body

{
  "app_name": "appNameBank",
  "app_type": "Web",
  "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
  "developer_email": "felixsmith@example.com",
  "company": "Tesobe GmbH",
  "redirect_url": "https://apisandbox.openbankproject.com",
  "enabled": true,
  "client_certificate": "-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----",
  "logo_url": "https://apisandbox.openbankproject.com/logo"
}

Example success response

{
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "consumer_key": "bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq",
  "app_name": "appNameBank",
  "app_type": "Web",
  "description": "Description of the object. Maximum length is 2000. It can be any characters here.",
  "developer_email": "felixsmith@example.com",
  "company": "Tesobe GmbH",
  "redirect_url": "https://apisandbox.openbankproject.com",
  "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n",
  "certificate_info": {
    "subject_domain_name": "OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE",
    "issuer_domain_name": "CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE",
    "not_before": "2022-04-01T10:13:00.000Z",
    "not_after": "2032-04-01T10:13:00.000Z",
    "roles_info": "PEM Encoded Certificate does not contain PSD2 roles."
  },
  "created_by_user": {
    "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email": "felixsmith@example.com",
    "provider_id": "Chris",
    "provider": "http://127.0.0.1:8080",
    "username": "felixsmith"
  },
  "enabled": true,
  "created": "1100-01-01T00:00:00Z",
  "logo_url": "https://apisandbox.openbankproject.com/logo"
}

Possible errors (5)

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-20108: Invalid redirect URL. Each redirect URL must use https, use http only for localhost, 127.0.0.1 or [::1], or use an app scheme in reverse-domain form such as com.example.app, and must not contain a wildcard, user information or a fragment. Rejected entry:
OBP-20109: Redirect URL host not allowed. This instance only accepts redirect URLs that point to the hosts listed for it. Rejected entry:
OBP-50000: Unknown Error.