What data is passed in a Claim?

What are you trying to build?

An external application that provides the User Type and adjusts if we identify an “employee” account. Cannot seem to get that claim information.

Environment

  • Product or API: Banno Admin External Applications
  • Environment: Production
  • Platform or runtime: Banno Admin
  • Authentication flow:
  • Documentation consulted: OpenID Connect and OAuth 2.0 | Banno SDK | Jack Henry Docs

What did you try?

We added the “user type” claim to the external application and they added the api usertype claim to their call. Unfortunately we saw no data come over for this claim.

What happened?

  • Expected result: See JSON referencing the user type on the call
  • Actual result: Vendor provided the JSON results and I saw no user type or claim information around the usertype claim. I only saw info on the member, customer identifier claim , and share claim
  • HTTP status, if applicable:
  • x-request-id, if available:
  • UTC date and time:

Safe-posting confirmation

  • I removed tokens, secrets, private keys, passwords, SSNs, account
    numbers, customer data, and institution-confidential configuration.

I believe the user type is only going to help you understand “retail or business” - I wouldn’t assume that claim also identifies employees of the FI.

For why it isn’t coming through, could the vendor share a sanitized copy of the authorization request’s claims parameter and identify which response they’re inspecting?

The claim reference lists the exact identifier as https://api.banno.com/consumer/claim/user_type, and the claims guide shows how to request it. Since you’re already seeing other claims, seeing that request would help narrow this down without guessing. It would also be helpful if you shared an x-request-id.

Thank you Sam! That makes a lot of sense. Is there a way a non-developer like ourselves can see the exact responses from these so we can help inform these decisions? I work with many different vendors that don’t fully know the Banno environment and rely on us as SMEs. I give them access to the tools but if I had that information it could help immensely.

The documentation does have schema information and examples in some cases - other than that, not really.