001/*
002 * oauth2-oidc-sdk
003 *
004 * Copyright 2012-2021, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.openid.connect.sdk.assurance.request;
019
020
021import net.minidev.json.JSONObject;
022
023
024/**
025 * The {@code verification} sub-element within an OpenID Connect
026 * {@link VerifiedClaimsSetRequest request for verified claims}.
027 *
028 * <p>Example:
029 *
030 * <pre>
031 * {
032 *   "trust_framework": null,
033 *   "time": null,
034 *   "evidence": [
035 *     {
036 *       "type": {
037 *         "value": "document"
038 *       },
039 *       "method": null,
040 *       "document_details": {
041 *         "type": null
042 *       }
043 *     }
044 *   ]
045 * }
046 * </pre>
047 *
048 * <p>Related specifications:
049 *
050 * <ul>
051 *     <li>OpenID Connect for Identity Assurance 1.0, section 6.
052 * </ul>
053 */
054public interface VerificationSpec {
055        
056        
057        /**
058         * Returns a JSON object representation of the verification element.
059         *
060         * <p>Example:
061         *
062         * <pre>
063         * {
064         *   "trust_framework": null,
065         *   "time": null,
066         *   "evidence": [
067         *     {
068         *       "type": {
069         *         "value": "document"
070         *       },
071         *       "method": null,
072         *       "document_details": {
073         *         "type": null
074         *       }
075         *     }
076         *   ]
077         * }
078         * </pre>
079         *
080         * @return The JSON object.
081         */
082        JSONObject toJSONObject();
083}