@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Credas API
@version v1
@auth ApiKey apikey in header
@common_fields {apikey: any}
@endpoints 37
@hint download_for_search
@toc api(37)

@endpoint POST /api/bank-accounts/verify
@optional {request: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint POST /api/companies
@optional {companyNumber: any}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint GET /api/companies/{companyId}
@required {companyId: any}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint POST /api/credit-status/perform
@optional {request: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint POST /api/datachecks
@optional {dataCheck: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint GET /api/images/selfie/{registrationId}
@required {registrationId: any}
@returns(200)
@errors {400, 401, 403, 500}

@endpoint POST /api/images/selfie
@optional {selfie: map}
@returns(200)
@errors {400, 401, 500}

@endpoint GET /api/images/liveness/{registrationId}
@required {registrationId: any}
@returns(200)
@errors {400, 401, 403, 500}

@endpoint POST /api/images/liveness
@optional {liveness: map}
@returns(200)
@errors {400, 401, 500}

@endpoint GET /api/images/liveness-performed/{registrationId}
@required {registrationId: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/images/id-document/{registrationId}
@required {registrationId: any}
@returns(200)
@errors {400, 401, 403, 500}

@endpoint POST /api/images/id-document
@optional {idDocument: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint GET /api/images/scan-report-pdf/{scanId}
@required {scanId: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint POST /api/property-register
@optional {request: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint GET /api/property-register/{id}
@required {id: any}
@returns(200)
@errors {400, 401, 404, 500}

@endpoint POST /api/registrations/instant
@optional {request: map}
@returns(200)
@errors {400, 401, 500}

@endpoint POST /api/registrations
@optional {registration: map}
@returns(200)
@errors {400, 401, 402, 500}

@endpoint GET /api/registrations/{id}/check-submitted-id-documents
@required {id: any}
@returns(200)
@errors {400, 401, 500}

@endpoint GET /api/registrations/referenceid/{referenceId}/summary
@required {referenceId: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/{id}/summary
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/regcode/{regCode}/summary
@required {regCode: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/{id}/supported-id-documents
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint PUT /api/registrations/{id}/status
@required {id: any}
@optional {request: map}
@returns(200)
@errors {400, 401, 404, 500}

@endpoint GET /api/registrations/{id}/pdf-export
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/{id}/pdf-export-sections
@required {id: any}
@optional {Comments: any, ContactDetails: any, StandardChecks: any, PepSanctionChecks: any, ProofOfOwnership: any, BankAccountCheck: any, CreditStatusCheck: any, Liveness: any, ExcludeSelfie: any, ExcludeIDDocuments: any, DIATFSection: any, SafeHarbourSection: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint PUT /api/registrations/{id}/override-check-status
@required {id: any}
@optional {request: map}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint POST /api/registrations/{id}/resend-invitation
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/{id}/settings
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint PUT /api/registrations/{id}/settings
@required {id: any}
@optional {settings: map}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint PUT /api/registrations/{id}/contact-details
@required {id: any}
@optional {details: map}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/search
@optional {pageNum: any, pageSize: any, forename: any, surname: any, email: any, dob: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/registrations/{id}/pdf-settlement-status
@required {id: any}
@returns(200)
@errors {400, 401, 403, 404, 500}

@endpoint GET /api/reg-types
@returns(200)
@errors {401, 500}

@endpoint POST /api/report-view/by-referenceid
@optional {request: map}
@returns(200)
@errors {400, 401, 500}

@endpoint POST /api/report-view/by-registrationid
@optional {request: map}
@returns(200)
@errors {400, 401, 500}

@endpoint POST /api/web-verifications/by-referenceid
@optional {request: map}
@returns(200)
@errors {400, 401, 500}

@endpoint POST /api/web-verifications/by-registrationid
@optional {request: map}
@returns(200)
@errors {400, 401, 500}

@end