Learn

Apple Identity Access certificates

Specifies paths and operations for managing Apple Identity Access certificates for mDocs verification.

Create an Apple Identity Access CSR

Creates an Apple Identity Access Certificate Signing Request (CSR) that can be uploaded to the Apple Developer Portal.

This certificate contains the public key that will be used to decrypt the response from the Apple Wallet.

Analytic events

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_START
  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_SUCCESS
  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_CREATE_FAIL
Roles: ["admin","verifier"]
SecuritybearerAuth
Request
Request Body schema: application/json
required

Apple Identity Access CSR payload

teamId
required
string

Team ID of the iOS app.

merchantId
required
string

The merchantIdentifier used by PassKit to retrieve credential data.

Responses
201

Apple Identity Access CSR created

400

Bad Request. The request was malformed or missing required parameters.

post/v2/presentations/certificates/apple-identity-access-certificates
Request samples
application/json
{
  • "teamId": "A2B3C4D5E6",
  • "merchantId": "com.domain.subdomain"
}
Response samples
application/json
{
  • "id": "fd44e792-45ac-11f0-bef8-bb24f133065e",
  • "teamId": "A2B3C4D5E6",
  • "merchantId": "com.domain.subdomain",
  • "csrPem": "string"
}

Retrieve all Apple Identity Access CSRs

Retrieves all Apple Identity Access CSRs created by the tenant.

Analytic events

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_START
  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_SUCCESS
  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_LIST_FAIL
Roles: ["admin","verifier"]
SecuritybearerAuth
Responses
200

Apple Identity Access CSRs retrieved

get/v2/presentations/certificates/apple-identity-access-certificates
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve an Apple Identity Access CSR
Retrieves an existing Apple Identity Access CSR.


Analytic events


    

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_START
    • 

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_RETRIEVE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
certificateId
required
string <uuid> 
Unique identifier for the Apple Identity Access CSR.


 
 Example:  673a20c3-97a3-40dd-b29a-115ff32b02c3
Responses 
200
Apple Identity Access Certificate CSR retrieved


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


get/v2/presentations/certificates/apple-identity-access-certificates/{certificateId}
Request samples 
Response samples 
application/json
{
  • "id": "fd44e792-45ac-11f0-bef8-bb24f133065e",
  • "teamId": "A2B3C4D5E6",
  • "merchantId": "com.domain.subdomain",
  • "csrPem": "string"
}
Delete an Apple Identity Access CSR
Deletes an existing Apple Identity Access CSR.


Analytic events


    

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_START
    • 

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_SUCCESS
    • 

  • CREDENTIAL_PRESENTATION_APPLE_IDENTITY_ACCESS_CERTIFICATE_DELETE_FAIL
    • 



Roles:  ["admin","verifier"]
SecuritybearerAuth 
Request 
path Parameters
certificateId
required
string <uuid> 
Unique identifier for the Apple Identity Access CSR.


 
 Example:  673a20c3-97a3-40dd-b29a-115ff32b02c3
Responses 
204
Apple Identity Access Certificate CSR deleted


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


delete/v2/presentations/certificates/apple-identity-access-certificates/{certificateId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
➔ Next to Verifier applications