Info: This ns is auto-generated from the Stripe OpenAPI spec.
Info: This ns is auto-generated from the Stripe OpenAPI spec.
(create-verification-sessions {:keys [body]})Create a VerificationSession
HTTP Method: POST Endpoint: /v1/identity/verification_sessions
Example Usage: (create-verification-sessions {})
Create a VerificationSession
HTTP Method: POST
Endpoint: /v1/identity/verification_sessions
Example Usage:
(create-verification-sessions {})(list-all-verification-reports {:keys [query-params]})List VerificationReports
HTTP Method: GET Endpoint: /v1/identity/verification_reports
Query Parameters:
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.Example Usage: (list-all-verification-reports {:query-params {:limit 10}})
List VerificationReports
HTTP Method: GET
Endpoint: /v1/identity/verification_reports
Query Parameters:
- client-reference-id (String): A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
- created (Unknown): Only return VerificationReports that were created during the given date interval.
- ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
- expand (Array): Specifies which fields in the response should be expanded.
- limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
- type (String): Only return VerificationReports of this type
- verification-session (String): Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.
Example Usage:
(list-all-verification-reports {:query-params {:limit 10}})(list-all-verification-sessions {:keys [query-params]})List VerificationSessions
HTTP Method: GET Endpoint: /v1/identity/verification_sessions
Query Parameters:
ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.Example Usage: (list-all-verification-sessions {:query-params {:limit 10}})
List VerificationSessions
HTTP Method: GET
Endpoint: /v1/identity/verification_sessions
Query Parameters:
- client-reference-id (String): A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
- created (Unknown): Only return VerificationSessions that were created during the given date interval.
- ending-before (String): A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
- expand (Array): Specifies which fields in the response should be expanded.
- limit (Integer): A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- related-customer (String): Customer ID
- related-customer-account (String): The ID of the Account representing a customer.
- starting-after (String): A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
- status (String): Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
Example Usage:
(list-all-verification-sessions {:query-params {:limit 10}})(post-verification-sessions-session-cancel {:keys [verification-session-id
body]})Cancel a VerificationSession
HTTP Method: POST Endpoint: /v1/identity/verification_sessions/{verification-session-id}/cancel
Path Parameters:
Example Usage: (post-verification-sessions-session-cancel {:verification-session-id example-verification-session-id})
Cancel a VerificationSession
HTTP Method: POST
Endpoint: /v1/identity/verification_sessions/{verification-session-id}/cancel
Path Parameters:
- verification-session-id (String): The verification-session-id parameter. (required)
Example Usage:
(post-verification-sessions-session-cancel {:verification-session-id example-verification-session-id})(post-verification-sessions-session-redact {:keys [verification-session-id
body]})Redact a VerificationSession
HTTP Method: POST Endpoint: /v1/identity/verification_sessions/{verification-session-id}/redact
Path Parameters:
Example Usage: (post-verification-sessions-session-redact {:verification-session-id example-verification-session-id})
Redact a VerificationSession
HTTP Method: POST
Endpoint: /v1/identity/verification_sessions/{verification-session-id}/redact
Path Parameters:
- verification-session-id (String): The verification-session-id parameter. (required)
Example Usage:
(post-verification-sessions-session-redact {:verification-session-id example-verification-session-id})(retrieve-verification-reports-report {:keys [verification-report-id
query-params]})Retrieve a VerificationReport
HTTP Method: GET Endpoint: /v1/identity/verification_reports/{verification-report-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-verification-reports-report {:verification-report-id example-verification-report-id :query-params {:limit 10}})
Retrieve a VerificationReport
HTTP Method: GET
Endpoint: /v1/identity/verification_reports/{verification-report-id}
Path Parameters:
- verification-report-id (String): The verification-report-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-verification-reports-report {:verification-report-id example-verification-report-id :query-params {:limit 10}})(retrieve-verification-sessions-session {:keys [verification-session-id
query-params]})Retrieve a VerificationSession
HTTP Method: GET Endpoint: /v1/identity/verification_sessions/{verification-session-id}
Path Parameters:
Query Parameters:
Example Usage: (retrieve-verification-sessions-session {:verification-session-id example-verification-session-id :query-params {:limit 10}})
Retrieve a VerificationSession
HTTP Method: GET
Endpoint: /v1/identity/verification_sessions/{verification-session-id}
Path Parameters:
- verification-session-id (String): The verification-session-id parameter. (required)
Query Parameters:
- expand (Array): Specifies which fields in the response should be expanded.
Example Usage:
(retrieve-verification-sessions-session {:verification-session-id example-verification-session-id :query-params {:limit 10}})(update-verification-sessions-session {:keys [verification-session-id body]})Update a VerificationSession
HTTP Method: POST Endpoint: /v1/identity/verification_sessions/{verification-session-id}
Path Parameters:
Example Usage: (update-verification-sessions-session {:verification-session-id example-verification-session-id})
Update a VerificationSession
HTTP Method: POST
Endpoint: /v1/identity/verification_sessions/{verification-session-id}
Path Parameters:
- verification-session-id (String): The verification-session-id parameter. (required)
Example Usage:
(update-verification-sessions-session {:verification-session-id example-verification-session-id})cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |