Partner chain

The partner_chain field captures intermediate relationships in multi-layered partner hierarchies that aren't represented elsewhere in the integration. It is intended for use by partners who award credentials via collaborations between multiple institutions and improves the granularity of analytics SEEK Pass can provide to you.

For example, a simple hierarchy between integration partner and credential issuer means that all relevant data is inherently captured without using partner_chain:

• Digital Credential Co (integration partner) ← data captured inherently in integration through request authorisation
• University A (credential issuer) ← data captured as education_provider in Education credential fields

The partner_chain field captures intermediary relationships between the integration partner and the credential issuer. For example, when an integration partner manages multiple institutions or institution groups:

• Digital Credential Co (integration partner) ← data captured inherently in integration through request authorisation
• ABC University Network (network of schools, partner of Digital Credential Co) ← this entity would not be visible in analytics without partner_chain
• University A (credential issuer, a member of ABC University Network) ← data captured as education_provider in Education fields

Notes

• partner_chain is represented as an array so that further layers of relationships can be represented. Order elements from parent to child, where parent is the integration partner and child is the credential issuer.
• Only include intermediary entities in partner_chain. Don't include the integration partner or the credential issuer, both of which are captured elsewhere in the request process.
• The concept of credential issuer changes depending on the credential type, for Education it is education_provider, for Learning and Development it is issuer_name, and for English it is test_provider. Please see individual credential documentation for required fields.

Examples

Single Intermediary

• Digital Credential Co: integration partner calling the AtSP API
• ABC University Network: A network of schools, partner of Digital Credential Co
• University A: credential issuer, member of ABC University Network

For this example, partner_chain contains only: [{ "name": "ABC University Network" }]

Multiple Intermediaries

• Digital Credential Co: integration partner calling the AtSP API
• ABC University Network: A network of schools, partner of Digital Credential Co
• Foo University Group: A smaller group of schools represented by ABC University Network
• University A: credential issuer, member of Foo University Group

For this example, partner_chain contains: [{ "name": "ABC University Network" }, { "name": "Foo University Group" }]

No Intermediaries

• Digital Credential Co: integration partner calling the AtSP API
• University A: credential issuer, partner of Digital Credential Co

For this example, partner_chain should not be passed