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
Request Body schema: application/jsonrequired
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. |
Apple Identity Access CSR created
Bad Request. The request was malformed or missing required parameters.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "teamId": "A2B3C4D5E6",
- "merchantId": "com.domain.subdomain"
}
- 201
- 400
{- "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
Apple Identity Access CSRs retrieved
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- {
- "id": "fd44e792-45ac-11f0-bef8-bb24f133065e",
- "teamId": "A2B3C4D5E6",
- "merchantId": "com.domain.subdomain",
- "csrPem": "string"
}
]
}
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
Apple Identity Access Certificate CSR retrieved
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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
Apple Identity Access Certificate CSR deleted
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}