Function getVerifiableCredential

getVerifiableCredential(
    vcUrl: string,
    options: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld: false;
        skipValidation?: boolean;
    },
): Promise<DatasetWithId>
Dereference a VC URL, and verify that the resulting content is valid.
Parameters
- vcUrl: string
  The URL of the VC.
- options: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld: false;
      skipValidation?: boolean;
  }
  Options to customize the function behavior.
  
  options.fetch: Specify a WHATWG-compatible authenticated fetch.
  
  options.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase
  - returnLegacyJsonld: false
  - OptionalskipValidation?: boolean
Returns Promise<DatasetWithId>
The dereferenced VC if valid. Throws otherwise.

Since
0.4.0
- Defined in common/common.ts:678
getVerifiableCredential(
    vcUrl: string,
    options?: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: true;
        skipValidation?: boolean;
    },
): Promise<VerifiableCredential>
Dereference a VC URL, and verify that the resulting content is valid.
Parameters
- vcUrl: string
  The URL of the VC.
- Optionaloptions: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: true;
      skipValidation?: boolean;
  }
  Options to customize the function behavior.
  
  options.fetch: Specify a WHATWG-compatible authenticated fetch.
  
  options.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: true
  - OptionalskipValidation?: boolean
Returns Promise<VerifiableCredential>
The dereferenced VC if valid. Throws otherwise.

Since
0.4.0

Deprecated
Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.
- Defined in common/common.ts:699
getVerifiableCredential(
    vcUrl: string,
    options?: ParseOptions & {
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
        returnLegacyJsonld?: boolean;
        skipValidation?: boolean;
    },
): Promise<DatasetWithId>
Dereference a VC URL, and verify that the resulting content is valid.
Parameters
- vcUrl: string
  The URL of the VC.
- Optionaloptions: ParseOptions & {
      fetch?: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
      normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase;
      returnLegacyJsonld?: boolean;
      skipValidation?: boolean;
  }
  Options to customize the function behavior.
  
  options.fetch: Specify a WHATWG-compatible authenticated fetch.
  
  options.returnLegacyJsonld: Include the normalized JSON-LD in the response
  - Optionalfetch?: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
  - Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase
  - OptionalreturnLegacyJsonld?: boolean
  - OptionalskipValidation?: boolean
Returns Promise<DatasetWithId>
The dereferenced VC if valid. Throws otherwise.

Since
0.4.0

Deprecated
Deprecated in favour of setting returnLegacyJsonld: false. This will be the default value in future versions of this library.
- Defined in common/common.ts:720

Function getVerifiableCredential

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

returnLegacyJsonld: false

`Optional`skipValidation?: boolean

Returns Promise<DatasetWithId>

Since

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

`Optional`skipValidation?: boolean

Returns Promise<VerifiableCredential>

Since

Deprecated

Parameters

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean

`Optional`skipValidation?: boolean

Returns Promise<DatasetWithId>

Since

Deprecated

Settings

Function getVerifiableCredential

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

returnLegacyJsonld: false

OptionalskipValidation?: boolean

Returns Promise<DatasetWithId>

Since

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: true

OptionalskipValidation?: boolean

Returns Promise<VerifiableCredential>

Since

Deprecated

Parameters

Optionalfetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response>;}

Optionalnormalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

OptionalreturnLegacyJsonld?: boolean

OptionalskipValidation?: boolean

Returns Promise<DatasetWithId>

Since

Deprecated

Settings

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`skipValidation?: boolean

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: true

`Optional`skipValidation?: boolean

`Optional`fetch?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

`Optional`normalize?: (object: VerifiableCredentialBase) => VerifiableCredentialBase

`Optional`returnLegacyJsonld?: boolean

`Optional`skipValidation?: boolean