Register
API Explorer
https://k3s.openbankproject.com

obp.createOrUpdateKycMedia

Create Or Update Kyc Media

Format grpc_vFeb2026 Group Core Suggested order 1

Outbound message (OBP to adapter) 
{
  "outboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj",
    "outboundAdapterAuthInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    },
    "outboundAdapterConsenterInfo": {
      "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "username": "felixsmith",
      "linkedCustomers": [
        {
          "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
          "customerNumber": "5987953",
          "legalName": "Eveline Tripman"
        }
      ],
      "userAuthContext": [
        {
          "key": "CustomerNumber",
          "value": "5987953"
        }
      ],
      "authViews": [
        {
          "view": {
            "id": "owner",
            "name": "owner",
            "description": "This view is for the owner for the account."
          },
          "account": {
            "id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
            "accountRoutings": [
              {
                "scheme": "IBAN",
                "address": "DE91 1000 0000 0123 4567 89"
              }
            ],
            "customerOwners": [
              {
                "bankId": "gh.29.uk",
                "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
                "customerNumber": "5987953",
                "legalName": "Eveline Tripman",
                "dateOfBirth": "2018-03-09T00:00:00Z"
              }
            ],
            "userOwners": [
              {
                "userId": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
                "emailAddress": "felixsmith@example.com",
                "name": "felixsmith"
              }
            ]
          }
        }
      ]
    }
  },
  "bankId": "gh.29.uk",
  "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
  "customerNumber": "5987953",
  "type": "",
  "url": "http://www.example.com/id-docs/123/image.png",
  "date": "2020-01-27T00:00:00Z",
  "relatesToKycDocumentId": "",
  "relatesToKycCheckId": ""
}
Inbound message (adapter to OBP) 
{
  "inboundAdapterCallContext": {
    "correlationId": "1flssoftxq0cr1nssr68u0mioj"
  },
  "status": {
    "errorCode": "Status errorCode",
    "backendMessages": [
      {
        "source": "",
        "status": "",
        "errorCode": "",
        "text": "",
        "duration": "5.123"
      }
    ]
  },
  "data": {
    "bankId": "gh.29.uk",
    "customerId": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "idKycMedia": "string",
    "customerNumber": "5987953",
    "type": "",
    "url": "http://www.example.com/id-docs/123/image.png",
    "date": "2020-01-27T00:00:00Z",
    "relatesToKycDocumentId": "",
    "relatesToKycCheckId": ""
  }
}