GraphQL API
Query the DeepV-ADK platform using GraphQL.Endpoint
``
https://api.deepv36.com/graphql
`
Authentication
Include your API key in the headers:
`
Authorization: Bearer YOUR_API_KEY
`
Example Query
`graphql
query GetAnalysis($id: ID!) {
analysis(id: $id) {
id
status
riskScore
decision
createdAt
applicant {
firstName
lastName
email
}
}
}
`
Variables:
`json
{
"id": "req_1234567890"
}
`
Mutations
Create Analysis
`graphql
mutation CreateAnalysis($input: AnalysisInput!) {
createAnalysis(input: $input) {
id
riskScore
decision
reasons
}
}
`
Variables:
`json
{
"input": {
"applicantData": {
"firstName": "John",
"lastName": "Doe",
"ssn": "123-45-6789"
},
"options": {
"includeReasons": true
}
}
}
`
Schema
Types
#### Analysis
`graphql
type Analysis {
id: ID!
status: AnalysisStatus!
riskScore: Int!
riscScore: RiscScore
decision: Decision!
reasons: [String!]
applicant: Applicant!
createdAt: DateTime!
updatedAt: DateTime!
}
`
#### Applicant
`graphql
type Applicant {
firstName: String!
lastName: String!
email: String
phone: String
address: Address
}
`
#### RiscScore
`graphql
type RiscScore {
total: Int!
components: RiscComponents!
}
`
Subscriptions
Subscribe to real-time updates:
`graphql
subscription OnAnalysisUpdate($id: ID!) {
analysisUpdated(id: $id) {
id
status
riskScore
}
}
`
Error Handling
GraphQL errors follow this format:
`json
{
"errors": [
{
"message": "Analysis not found",
"extensions": {
"code": "NOT_FOUND",
"id": "req_invalid"
}
}
]
}
``
Next Steps
Found an issue? Help us improve this page.