Create a Validation Submission
POST/v1/validation-submissions
Create a Validation Submission
Request​
Header Parameters
Idempotency key
- application/json
Body
required
- MOD1
- MOD2
Id of the Validation Submission Configuration associated with submission
Possible values: <= 255 characters
Name of organisation
Possible values: <= 255 characters
Name of organisation's registry
Organisations's id in registry
Possible values: <= 255 characters
Organisation's email
Possible values: <= 255 characters
Organisation's address line 1
Possible values: <= 255 characters
Organisation's address line 2
Possible values: <= 255 characters
Organisation's city
Possible values: <= 255 characters
Organisation's postal code
Possible values: <= 255 characters
Organisation's state
Possible values: <= 255 characters
Organisation's website
Three-letter ISO country code
Possible values: <= 255 characters
First name of Agent
Possible values: <= 255 characters
Last name of Agent
Possible values: <= 255 characters
Email of Agent
Possible values: <= 255 characters
Agent's job title
Valid RFC 5646 language code
metadata object
Metadata object.
Max key size is 40 characters
Id of the Validation Submission Configuration
OrganisationId of the Agent
Possible values: <= 255 characters
First name of Agent
Possible values: <= 255 characters
Last name of Agent
Possible values: <= 255 characters
Email of Agent
Possible values: <= 255 characters
Agent's job title
Possible values: <= 255 characters
Organization's website
Valid RFC 5646 language code
metadata object
Metadata object.
Max key size is 40 characters. If key matches already existing key, it will override old value
Responses​
- 200
- 400
- 401
- 403
Successfully created a Validation Submission
- application/json
- Schema
- Example (from schema)
Schema
data object
Possible values: [pending
, failed
, succeeded
, processed
]
agentVerification objectnullable
Possible values: [pending
, pending_user_verification
, pending_review
, approved
, rejected
]
Possible values: [Validation request failed
, User verification expired
, Identity check failed
, No evidence agent’s email is associated with organisation
, Agent/nonprofit will reapply
, Agent used fake or test email
, No online presence to complete check
, Nonprofit association expired
, Other
]
Reason for rejecting agent verification
Possible values: [validation_request_failed
, user_verification_expired
, user_failed_percent_review
, reapply
, fake_email_used
, no_online_presence
, invalid_documentation
, nonprofit_association_expired
, fake_documentation
, mismatched_information
, blank_corrupted_documentation
, suspicious_application
, other
]
Reason code for rejecting agent verification
validationRequest objectnullable
Possible values: [nonprofit
, social_impact
]
eligibility object
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
, cannot_define_eligibility
]
results object
Possible values: [pass
, fail
]
Confirmed organisation's activity subtags that are not allowed in partner's configuration
monitoring object
Possible values: [live
, pending_validation_request
, validation_request_failed
, pending
, cancelled
]
results object
Possible values: [pass
, fail
]
registration object
Possible values: [yes
, no
]
warning objectnullable
Possible values: [clear
, flag
]
sanction objectnullable
Possible values: [clear
, flag
]
controversial objectnullable
Possible values: [clear
, flag
]
commercial objectnullable
Possible values: [clear
, flag
]
adverseMedia objectnullable
Possible values: [clear
, flag
]
hateSpeech objectnullable
Possible values: [clear
, flag
]
configuration object
Validation Submission configuration id
Validation Submission configuration name
Key-value data that you can attach to an object.
Responses for custom partner questions
{
"data": {
"id": "validationsubmission_xxxxxxxxxxxx",
"validationInviteId": "validationinvite_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": "pending",
"processedAt": "2022-02-02T17:46:54.000Z",
"organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"organisationName": "string",
"monitoringSubscriptionId": "monitoringsubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"eligibilitySubscriptionId": "eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"createdAt": "2022-02-02T17:46:54.000Z",
"agentVerificationId": "agentverification_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"agentVerification": {
"id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "string",
"firstName": "string",
"lastName": "string",
"status": "pending",
"rejectionReasonCode": "validation_request_failed"
},
"validationRequestId": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"validationRequest": {
"acceptedAt": "2022-02-02T17:46:54.000Z",
"rejectedAt": "2022-02-02T17:46:54.000Z",
"id": "validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "string",
"organisationTypes": [
"nonprofit"
]
},
"eligibility": {
"status": "live",
"results": {
"eligibilityStatus": "fail",
"confirmedActivitySubTags": [
"activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
],
"rejectedActivitySubTags": [
"activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
]
}
},
"monitoring": {
"status": "live",
"results": {
"complianceStatus": "fail",
"registration": {
"active": "no"
},
"warning": {
"status": "flag"
},
"sanction": {
"status": "flag"
},
"controversial": {
"status": "flag"
},
"commercial": {
"status": "flag"
},
"adverseMedia": {
"status": "clear"
},
"hateSpeech": {
"status": "flag"
}
}
},
"configuration": {
"id": "hostedconfiguration_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "string"
},
"metadata": {
"key1": "value1",
"key2": "value2"
},
"partnerFields": {
"key1": "value1",
"key2": "value2"
}
},
"object": "validation_submission"
}
Bad request
- application/json
- Schema
- Example (from schema)
- OrganisationNotFound
- OrganisationNotActive
- ValidationSubmissionDocumentNotFound
- ValidationRequestNotFound
- ValidationRequestAlreadyRejected
- EntityNotFound
- InvalidSubTags
- InvalidConfiguration
- OriginalCallInProgress
- SameKeyDifferentData
- KeyInUse
Schema
error object
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
400 Bad request
{
"error": {
"code": "validation_submission/organisation_not_found",
"title": "Bad request",
"message": "Organisation was not found"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/organisation_not_active",
"title": "Bad request",
"message": "Organisation is not active"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/validation_submission_document_not_found",
"title": "Bad request",
"message": "Validation submission document was not found"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/validation_request_not_found",
"title": "Bad request",
"message": "Validation request was not found"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/validation_request_already_rejected",
"title": "Bad request",
"message": "Validation request already rejected"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/entity_not_found",
"title": "Bad request",
"message": "Organisation or validation request was not found"
}
}
400 Bad request
{
"error": {
"code": "validation_submission/invalid_sub_tags",
"title": "Bad request",
"message": "At least one of provided subtags is invalid"
}
}
404 Not Found
{
"error": {
"code": "validation_submission/invalid_configuration_id",
"title": "Not Found",
"message": "Provided configurationId is not valid"
}
}
Idempotency - Original call in progress
{
"error": {
"code": "idempotency/original_call_in_progress",
"title": "Bad request",
"message": "Original call with this idempotency key is still in progress"
}
}
Idempotency - Data has changed from previous request
{
"error": {
"code": "idempotency/same_key_different_data",
"title": "Bad request",
"message": "Data has changed from previous request"
}
}
Idempotency - Key in use
{
"error": {
"code": "idempotency/key_already_in_use",
"title": "Bad request",
"message": "Idempotency Key is already in use"
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}