@model-match/api 3.12.0 → 3.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{index-CmXuxD3J.d.mts → index-CuTxsP19.d.mts} +237 -5
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +2 -2
- package/dist/slim/index.d.mts +17 -2
- package/dist/slim/index.mjs +57 -2
- package/dist/{src-B_YslAkc.mjs → src-Bm5e4LYA.mjs} +58 -1
- package/openapi.json +630 -5
- package/package.json +2 -2
package/openapi.json
CHANGED
|
@@ -582,6 +582,357 @@
|
|
|
582
582
|
],
|
|
583
583
|
"type": "object"
|
|
584
584
|
},
|
|
585
|
+
"AdminCadLinks": {
|
|
586
|
+
"properties": {
|
|
587
|
+
"current": {
|
|
588
|
+
"nullable": true,
|
|
589
|
+
"properties": {
|
|
590
|
+
"companyName": {
|
|
591
|
+
"nullable": true,
|
|
592
|
+
"type": "string"
|
|
593
|
+
},
|
|
594
|
+
"companyNmlsId": {
|
|
595
|
+
"nullable": true,
|
|
596
|
+
"type": "string"
|
|
597
|
+
},
|
|
598
|
+
"startDate": {
|
|
599
|
+
"nullable": true,
|
|
600
|
+
"type": "string"
|
|
601
|
+
}
|
|
602
|
+
},
|
|
603
|
+
"required": [
|
|
604
|
+
"companyNmlsId",
|
|
605
|
+
"companyName",
|
|
606
|
+
"startDate"
|
|
607
|
+
],
|
|
608
|
+
"type": "object"
|
|
609
|
+
},
|
|
610
|
+
"explanation": {
|
|
611
|
+
"properties": {
|
|
612
|
+
"activeLogic": {
|
|
613
|
+
"type": "string"
|
|
614
|
+
},
|
|
615
|
+
"registrationLink": {
|
|
616
|
+
"type": "string"
|
|
617
|
+
},
|
|
618
|
+
"sponsorshipLink": {
|
|
619
|
+
"type": "string"
|
|
620
|
+
}
|
|
621
|
+
},
|
|
622
|
+
"required": [
|
|
623
|
+
"sponsorshipLink",
|
|
624
|
+
"registrationLink",
|
|
625
|
+
"activeLogic"
|
|
626
|
+
],
|
|
627
|
+
"type": "object"
|
|
628
|
+
},
|
|
629
|
+
"indexGaps": {
|
|
630
|
+
"items": {
|
|
631
|
+
"type": "string"
|
|
632
|
+
},
|
|
633
|
+
"type": "array"
|
|
634
|
+
},
|
|
635
|
+
"isWorking": {
|
|
636
|
+
"nullable": true,
|
|
637
|
+
"type": "boolean"
|
|
638
|
+
},
|
|
639
|
+
"name": {
|
|
640
|
+
"nullable": true,
|
|
641
|
+
"type": "string"
|
|
642
|
+
},
|
|
643
|
+
"nmlsId": {
|
|
644
|
+
"type": "string"
|
|
645
|
+
},
|
|
646
|
+
"registrations": {
|
|
647
|
+
"properties": {
|
|
648
|
+
"active": {
|
|
649
|
+
"type": "number"
|
|
650
|
+
},
|
|
651
|
+
"inactive": {
|
|
652
|
+
"type": "number"
|
|
653
|
+
},
|
|
654
|
+
"rows": {
|
|
655
|
+
"items": {
|
|
656
|
+
"properties": {
|
|
657
|
+
"companyName": {
|
|
658
|
+
"nullable": true,
|
|
659
|
+
"type": "string"
|
|
660
|
+
},
|
|
661
|
+
"companyNmlsId": {
|
|
662
|
+
"nullable": true,
|
|
663
|
+
"type": "string"
|
|
664
|
+
},
|
|
665
|
+
"endDate": {
|
|
666
|
+
"nullable": true,
|
|
667
|
+
"type": "string"
|
|
668
|
+
},
|
|
669
|
+
"isActive": {
|
|
670
|
+
"type": "boolean"
|
|
671
|
+
},
|
|
672
|
+
"licenseType": {
|
|
673
|
+
"nullable": true,
|
|
674
|
+
"type": "string"
|
|
675
|
+
},
|
|
676
|
+
"locationNmlsId": {
|
|
677
|
+
"nullable": true,
|
|
678
|
+
"type": "string"
|
|
679
|
+
},
|
|
680
|
+
"regulator": {
|
|
681
|
+
"nullable": true,
|
|
682
|
+
"type": "string"
|
|
683
|
+
},
|
|
684
|
+
"source": {
|
|
685
|
+
"enum": [
|
|
686
|
+
"sponsorship",
|
|
687
|
+
"registration",
|
|
688
|
+
null
|
|
689
|
+
],
|
|
690
|
+
"nullable": true,
|
|
691
|
+
"type": "string"
|
|
692
|
+
},
|
|
693
|
+
"startDate": {
|
|
694
|
+
"nullable": true,
|
|
695
|
+
"type": "string"
|
|
696
|
+
}
|
|
697
|
+
},
|
|
698
|
+
"required": [
|
|
699
|
+
"source",
|
|
700
|
+
"companyNmlsId",
|
|
701
|
+
"companyName",
|
|
702
|
+
"startDate",
|
|
703
|
+
"endDate",
|
|
704
|
+
"isActive",
|
|
705
|
+
"regulator",
|
|
706
|
+
"licenseType",
|
|
707
|
+
"locationNmlsId"
|
|
708
|
+
],
|
|
709
|
+
"type": "object"
|
|
710
|
+
},
|
|
711
|
+
"type": "array"
|
|
712
|
+
},
|
|
713
|
+
"total": {
|
|
714
|
+
"type": "number"
|
|
715
|
+
}
|
|
716
|
+
},
|
|
717
|
+
"required": [
|
|
718
|
+
"total",
|
|
719
|
+
"active",
|
|
720
|
+
"inactive",
|
|
721
|
+
"rows"
|
|
722
|
+
],
|
|
723
|
+
"type": "object"
|
|
724
|
+
},
|
|
725
|
+
"sponsorships": {
|
|
726
|
+
"properties": {
|
|
727
|
+
"active": {
|
|
728
|
+
"type": "number"
|
|
729
|
+
},
|
|
730
|
+
"inactive": {
|
|
731
|
+
"type": "number"
|
|
732
|
+
},
|
|
733
|
+
"rows": {
|
|
734
|
+
"items": {
|
|
735
|
+
"properties": {
|
|
736
|
+
"companyName": {
|
|
737
|
+
"nullable": true,
|
|
738
|
+
"type": "string"
|
|
739
|
+
},
|
|
740
|
+
"companyNmlsId": {
|
|
741
|
+
"nullable": true,
|
|
742
|
+
"type": "string"
|
|
743
|
+
},
|
|
744
|
+
"endDate": {
|
|
745
|
+
"nullable": true,
|
|
746
|
+
"type": "string"
|
|
747
|
+
},
|
|
748
|
+
"isActive": {
|
|
749
|
+
"type": "boolean"
|
|
750
|
+
},
|
|
751
|
+
"licenseType": {
|
|
752
|
+
"nullable": true,
|
|
753
|
+
"type": "string"
|
|
754
|
+
},
|
|
755
|
+
"locationNmlsId": {
|
|
756
|
+
"nullable": true,
|
|
757
|
+
"type": "string"
|
|
758
|
+
},
|
|
759
|
+
"regulator": {
|
|
760
|
+
"nullable": true,
|
|
761
|
+
"type": "string"
|
|
762
|
+
},
|
|
763
|
+
"source": {
|
|
764
|
+
"enum": [
|
|
765
|
+
"sponsorship",
|
|
766
|
+
"registration",
|
|
767
|
+
null
|
|
768
|
+
],
|
|
769
|
+
"nullable": true,
|
|
770
|
+
"type": "string"
|
|
771
|
+
},
|
|
772
|
+
"startDate": {
|
|
773
|
+
"nullable": true,
|
|
774
|
+
"type": "string"
|
|
775
|
+
}
|
|
776
|
+
},
|
|
777
|
+
"required": [
|
|
778
|
+
"source",
|
|
779
|
+
"companyNmlsId",
|
|
780
|
+
"companyName",
|
|
781
|
+
"startDate",
|
|
782
|
+
"endDate",
|
|
783
|
+
"isActive",
|
|
784
|
+
"regulator",
|
|
785
|
+
"licenseType",
|
|
786
|
+
"locationNmlsId"
|
|
787
|
+
],
|
|
788
|
+
"type": "object"
|
|
789
|
+
},
|
|
790
|
+
"type": "array"
|
|
791
|
+
},
|
|
792
|
+
"total": {
|
|
793
|
+
"type": "number"
|
|
794
|
+
}
|
|
795
|
+
},
|
|
796
|
+
"required": [
|
|
797
|
+
"total",
|
|
798
|
+
"active",
|
|
799
|
+
"inactive",
|
|
800
|
+
"rows"
|
|
801
|
+
],
|
|
802
|
+
"type": "object"
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"required": [
|
|
806
|
+
"nmlsId",
|
|
807
|
+
"name",
|
|
808
|
+
"isWorking",
|
|
809
|
+
"current",
|
|
810
|
+
"sponsorships",
|
|
811
|
+
"registrations",
|
|
812
|
+
"explanation",
|
|
813
|
+
"indexGaps"
|
|
814
|
+
],
|
|
815
|
+
"type": "object"
|
|
816
|
+
},
|
|
817
|
+
"AdminCadLoadLaunch": {
|
|
818
|
+
"properties": {
|
|
819
|
+
"payload": {
|
|
820
|
+
"additionalProperties": {
|
|
821
|
+
"nullable": true
|
|
822
|
+
},
|
|
823
|
+
"type": "object"
|
|
824
|
+
},
|
|
825
|
+
"taskArn": {
|
|
826
|
+
"type": "string"
|
|
827
|
+
},
|
|
828
|
+
"taskId": {
|
|
829
|
+
"type": "string"
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
"required": [
|
|
833
|
+
"taskId",
|
|
834
|
+
"taskArn",
|
|
835
|
+
"payload"
|
|
836
|
+
],
|
|
837
|
+
"type": "object"
|
|
838
|
+
},
|
|
839
|
+
"AdminCadLoadRequest": {
|
|
840
|
+
"properties": {
|
|
841
|
+
"bucket": {
|
|
842
|
+
"description": "Source bucket (default `nmls-raw-data`).",
|
|
843
|
+
"minLength": 1,
|
|
844
|
+
"type": "string"
|
|
845
|
+
},
|
|
846
|
+
"loadType": {
|
|
847
|
+
"description": "`sample` loads only the first file. Default `full`.",
|
|
848
|
+
"enum": [
|
|
849
|
+
"full",
|
|
850
|
+
"sample"
|
|
851
|
+
],
|
|
852
|
+
"type": "string"
|
|
853
|
+
},
|
|
854
|
+
"prefix": {
|
|
855
|
+
"description": "S3 prefix of one month's NMLS file set. Required unless resuming.",
|
|
856
|
+
"example": "consumer-access/2026/ConsumerAccess_nmlsb2bfiles_Sep2026/",
|
|
857
|
+
"minLength": 1,
|
|
858
|
+
"type": "string"
|
|
859
|
+
},
|
|
860
|
+
"reindex": {
|
|
861
|
+
"description": "Launch a full `index-cad` run when the load completes.",
|
|
862
|
+
"type": "boolean"
|
|
863
|
+
},
|
|
864
|
+
"restartFromFile": {
|
|
865
|
+
"description": "With `resumeLoadId`: reset this file (e.g. `Branch.csv`) and every later one first.",
|
|
866
|
+
"minLength": 1,
|
|
867
|
+
"type": "string"
|
|
868
|
+
},
|
|
869
|
+
"resumeLoadId": {
|
|
870
|
+
"description": "Resume an existing load by its id (resets stuck/failed files).",
|
|
871
|
+
"minLength": 1,
|
|
872
|
+
"type": "string"
|
|
873
|
+
}
|
|
874
|
+
},
|
|
875
|
+
"type": "object"
|
|
876
|
+
},
|
|
877
|
+
"AdminCadLoadTaskStatus": {
|
|
878
|
+
"properties": {
|
|
879
|
+
"createdAt": {
|
|
880
|
+
"nullable": true,
|
|
881
|
+
"type": "string"
|
|
882
|
+
},
|
|
883
|
+
"desiredStatus": {
|
|
884
|
+
"nullable": true,
|
|
885
|
+
"type": "string"
|
|
886
|
+
},
|
|
887
|
+
"exitCode": {
|
|
888
|
+
"nullable": true,
|
|
889
|
+
"type": "number"
|
|
890
|
+
},
|
|
891
|
+
"lastStatus": {
|
|
892
|
+
"type": "string"
|
|
893
|
+
},
|
|
894
|
+
"startedAt": {
|
|
895
|
+
"nullable": true,
|
|
896
|
+
"type": "string"
|
|
897
|
+
},
|
|
898
|
+
"state": {
|
|
899
|
+
"enum": [
|
|
900
|
+
"pending",
|
|
901
|
+
"running",
|
|
902
|
+
"succeeded",
|
|
903
|
+
"failed"
|
|
904
|
+
],
|
|
905
|
+
"type": "string"
|
|
906
|
+
},
|
|
907
|
+
"stoppedAt": {
|
|
908
|
+
"nullable": true,
|
|
909
|
+
"type": "string"
|
|
910
|
+
},
|
|
911
|
+
"stoppedReason": {
|
|
912
|
+
"nullable": true,
|
|
913
|
+
"type": "string"
|
|
914
|
+
},
|
|
915
|
+
"taskArn": {
|
|
916
|
+
"type": "string"
|
|
917
|
+
},
|
|
918
|
+
"taskId": {
|
|
919
|
+
"type": "string"
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
"required": [
|
|
923
|
+
"taskId",
|
|
924
|
+
"taskArn",
|
|
925
|
+
"state",
|
|
926
|
+
"lastStatus",
|
|
927
|
+
"desiredStatus",
|
|
928
|
+
"exitCode",
|
|
929
|
+
"stoppedReason",
|
|
930
|
+
"createdAt",
|
|
931
|
+
"startedAt",
|
|
932
|
+
"stoppedAt"
|
|
933
|
+
],
|
|
934
|
+
"type": "object"
|
|
935
|
+
},
|
|
585
936
|
"AdminPushAlertRequest": {
|
|
586
937
|
"properties": {
|
|
587
938
|
"dedupeKey": {
|
|
@@ -23317,6 +23668,13 @@
|
|
|
23317
23668
|
"example": 48213,
|
|
23318
23669
|
"minimum": 0,
|
|
23319
23670
|
"type": "integer"
|
|
23671
|
+
},
|
|
23672
|
+
"totalIsLowerBound": {
|
|
23673
|
+
"description": "Present (always `true`) only under `timeAtCompanyMonths` when the other filters match more than 200,000 originators: `total` then counts the tenure matches among the first 200,000 of them (in sort order) and the true count may be higher. Absent means `total` is exact.",
|
|
23674
|
+
"enum": [
|
|
23675
|
+
true
|
|
23676
|
+
],
|
|
23677
|
+
"type": "boolean"
|
|
23320
23678
|
}
|
|
23321
23679
|
},
|
|
23322
23680
|
"required": [
|
|
@@ -24331,6 +24689,46 @@
|
|
|
24331
24689
|
"nmlsId": {
|
|
24332
24690
|
"$ref": "#/components/schemas/TextFilterValue"
|
|
24333
24691
|
},
|
|
24692
|
+
"officeCity": {
|
|
24693
|
+
"allOf": [
|
|
24694
|
+
{
|
|
24695
|
+
"$ref": "#/components/schemas/TextFilterValue"
|
|
24696
|
+
},
|
|
24697
|
+
{
|
|
24698
|
+
"description": "Office city — matches originators whose NMLS-registered office is in this city (NOT where they produced loans; that is `city`). Resolved through the location dictionary, so spelling variants match (`Saint Louis` = `St. Louis`); pair it with `officeState` to pick one of several same-named cities (a sibling production `state` does NOT disambiguate it), or pass a dictionary city id. An unrecognized city is a 400 naming `instantSearch`. Pass an array to match any of several."
|
|
24699
|
+
}
|
|
24700
|
+
]
|
|
24701
|
+
},
|
|
24702
|
+
"officeCounty": {
|
|
24703
|
+
"allOf": [
|
|
24704
|
+
{
|
|
24705
|
+
"$ref": "#/components/schemas/TextFilterValue"
|
|
24706
|
+
},
|
|
24707
|
+
{
|
|
24708
|
+
"description": "Office county — matches originators whose NMLS-registered office zip lies in this county. Accepts a county name (`Orleans`, with a sibling `officeState` when the name exists in several states), a 5-digit FIPS code (`22071`) or a dictionary county id. The office address carries no county of its own, so it is derived from the office zip: each zip is assigned to the ONE county holding most of its parcels, which makes the counties of a state partition its offices but attributes an office in a zip that straddles a county line to the zip's main county. An unrecognized county is a 400."
|
|
24709
|
+
}
|
|
24710
|
+
]
|
|
24711
|
+
},
|
|
24712
|
+
"officeState": {
|
|
24713
|
+
"allOf": [
|
|
24714
|
+
{
|
|
24715
|
+
"$ref": "#/components/schemas/TextFilterValue"
|
|
24716
|
+
},
|
|
24717
|
+
{
|
|
24718
|
+
"description": "Office state — matches originators whose NMLS-registered office is in this state (NOT where they produced loans; that is `state`). A 2-letter code or full name (`LA` or `Louisiana`), any case; pass an array to match any of several. Period-independent. Originators with no office address on file never match."
|
|
24719
|
+
}
|
|
24720
|
+
]
|
|
24721
|
+
},
|
|
24722
|
+
"officeZip": {
|
|
24723
|
+
"allOf": [
|
|
24724
|
+
{
|
|
24725
|
+
"$ref": "#/components/schemas/TextFilterValue"
|
|
24726
|
+
},
|
|
24727
|
+
{
|
|
24728
|
+
"description": "Office zip code — matches originators whose NMLS-registered office is in this 5-digit zip (ZIP+4 office addresses match their 5-digit prefix). Pass an array to match any of several."
|
|
24729
|
+
}
|
|
24730
|
+
]
|
|
24731
|
+
},
|
|
24334
24732
|
"opportunityZoneCount": {
|
|
24335
24733
|
"allOf": [
|
|
24336
24734
|
{
|
|
@@ -24574,7 +24972,7 @@
|
|
|
24574
24972
|
]
|
|
24575
24973
|
},
|
|
24576
24974
|
"timeAtCompanyMonths": {
|
|
24577
|
-
"description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value.
|
|
24975
|
+
"description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value. Not sortable — sort by `yearsInIndustry` or production instead. Applied after the rest of the request: the other filters are matched first, in the request's sort order, and each match is checked against the registration record, so it works at any result size up to 200,000 matches of the OTHER filters. Past that, `total` counts only the tenure matches among the first 200,000 scanned and the response carries `totalIsLowerBound: true`; a page beyond what was found answers 400 with `code: \"TIME_AT_COMPANY_SCOPE\"` — add a geography, production or company filter to narrow. Pages use an opaque offset cursor; pass `cursor` back unchanged. Flat filters only, and not inside `mode: \"or\"`.",
|
|
24578
24976
|
"nullable": true,
|
|
24579
24977
|
"properties": {
|
|
24580
24978
|
"gt": {
|
|
@@ -24735,7 +25133,8 @@
|
|
|
24735
25133
|
"countyFips",
|
|
24736
25134
|
"producersOnly",
|
|
24737
25135
|
"yearsInIndustry",
|
|
24738
|
-
"
|
|
25136
|
+
"officeState",
|
|
25137
|
+
"officeCity"
|
|
24739
25138
|
],
|
|
24740
25139
|
"type": "string"
|
|
24741
25140
|
},
|
|
@@ -24773,6 +25172,13 @@
|
|
|
24773
25172
|
},
|
|
24774
25173
|
"total": {
|
|
24775
25174
|
"type": "number"
|
|
25175
|
+
},
|
|
25176
|
+
"totalIsLowerBound": {
|
|
25177
|
+
"description": "Present (always `true`) only under `timeAtCompanyMonths` when the other filters match more than 200,000 originators: `total` then counts the tenure matches among the first 200,000 of them (in sort order) and the true count may be higher. Absent means `total` is exact.",
|
|
25178
|
+
"enum": [
|
|
25179
|
+
true
|
|
25180
|
+
],
|
|
25181
|
+
"type": "boolean"
|
|
24776
25182
|
}
|
|
24777
25183
|
},
|
|
24778
25184
|
"required": [
|
|
@@ -25654,6 +26060,21 @@
|
|
|
25654
26060
|
"nullable": true,
|
|
25655
26061
|
"type": "string"
|
|
25656
26062
|
},
|
|
26063
|
+
"officeCity": {
|
|
26064
|
+
"description": "City of the originator's NMLS-registered office — the value the `officeCity` filter matches. Null when no office address is on file.",
|
|
26065
|
+
"nullable": true,
|
|
26066
|
+
"type": "string"
|
|
26067
|
+
},
|
|
26068
|
+
"officeState": {
|
|
26069
|
+
"description": "2-letter state of the originator's NMLS-registered office — the value the `officeState` filter matches.",
|
|
26070
|
+
"nullable": true,
|
|
26071
|
+
"type": "string"
|
|
26072
|
+
},
|
|
26073
|
+
"officeZip": {
|
|
26074
|
+
"description": "Zip of the originator's NMLS-registered office as stored (5-digit, occasionally ZIP+4) — the value the `officeZip` filter matches.",
|
|
26075
|
+
"nullable": true,
|
|
26076
|
+
"type": "string"
|
|
26077
|
+
},
|
|
25657
26078
|
"phone": {
|
|
25658
26079
|
"nullable": true,
|
|
25659
26080
|
"type": "string"
|
|
@@ -31271,7 +31692,7 @@
|
|
|
31271
31692
|
"info": {
|
|
31272
31693
|
"description": "ModelMatch API — mortgage and real-estate market data.\n\n## Bulk delivery limits\n\nThe `POST /{entity}/bulk-delivery` endpoints export a full result set to\nS3 as NDJSON, JSON, CSV, or Parquet.\n\n- **Up to 1,000 rows per delivery: no entitlement required.** Available to\n every authenticated caller.\n- **Above 1,000 rows: requires the entity's `bulk-delivery.{entity}`\n entitlement** (e.g. `bulk-delivery.loans`). The grant's scope sets your\n row ceiling and may also restrict which rows and fields you receive.\n\nA delivery that would exceed the limit available to you is rejected with\n`403 entitlement_missing`, reporting the matched row count and the ceiling\nthat applied. To stay under the limit, pass `limit` — the job then delivers\n(and bills for) only the first `limit` rows of a broader query.\n\n**Need a higher limit?** Email support@modelmatch.com to request the\nentitlement. Limits are raised per organization and per entity.\n\nBulk delivery is billed at 1 credit per delivered row whether or not\nan entitlement is held.",
|
|
31273
31694
|
"title": "ModelMatch API",
|
|
31274
|
-
"version": "3.
|
|
31695
|
+
"version": "3.58.0"
|
|
31275
31696
|
},
|
|
31276
31697
|
"openapi": "3.1.0",
|
|
31277
31698
|
"paths": {
|
|
@@ -33066,7 +33487,7 @@
|
|
|
33066
33487
|
}
|
|
33067
33488
|
}
|
|
33068
33489
|
},
|
|
33069
|
-
"description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
|
|
33490
|
+
"description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value. Also returned with `code: \"TIME_AT_COMPANY_SCOPE\"` when `timeAtCompanyMonths` is set, the other filters match more than 200,000 originators, and the requested page lies past the tenure matches found among the first 200,000 — narrow the request."
|
|
33070
33491
|
},
|
|
33071
33492
|
"401": {
|
|
33072
33493
|
"content": {
|
|
@@ -34959,6 +35380,210 @@
|
|
|
34959
35380
|
]
|
|
34960
35381
|
}
|
|
34961
35382
|
},
|
|
35383
|
+
"/v1/admin/cad/links/{nmlsId}": {
|
|
35384
|
+
"get": {
|
|
35385
|
+
"description": "Diagnostic: the LO's indexed employment union (sponsorships + registrations), split by source with active counts. `indexGaps` lists what the former database diagnostic showed that the index does not carry.",
|
|
35386
|
+
"operationId": "adminGetCadLinks",
|
|
35387
|
+
"parameters": [
|
|
35388
|
+
{
|
|
35389
|
+
"description": "Individual NMLS id.",
|
|
35390
|
+
"in": "path",
|
|
35391
|
+
"name": "nmlsId",
|
|
35392
|
+
"required": true,
|
|
35393
|
+
"schema": {
|
|
35394
|
+
"description": "Individual NMLS id.",
|
|
35395
|
+
"example": "3352",
|
|
35396
|
+
"pattern": "^\\d+$/u",
|
|
35397
|
+
"type": "string"
|
|
35398
|
+
}
|
|
35399
|
+
}
|
|
35400
|
+
],
|
|
35401
|
+
"responses": {
|
|
35402
|
+
"200": {
|
|
35403
|
+
"content": {
|
|
35404
|
+
"application/json": {
|
|
35405
|
+
"schema": {
|
|
35406
|
+
"$ref": "#/components/schemas/AdminCadLinks"
|
|
35407
|
+
}
|
|
35408
|
+
}
|
|
35409
|
+
},
|
|
35410
|
+
"description": "Links"
|
|
35411
|
+
},
|
|
35412
|
+
"401": {
|
|
35413
|
+
"content": {
|
|
35414
|
+
"application/json": {
|
|
35415
|
+
"schema": {
|
|
35416
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35417
|
+
}
|
|
35418
|
+
}
|
|
35419
|
+
},
|
|
35420
|
+
"description": "Not authenticated"
|
|
35421
|
+
},
|
|
35422
|
+
"403": {
|
|
35423
|
+
"content": {
|
|
35424
|
+
"application/json": {
|
|
35425
|
+
"schema": {
|
|
35426
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35427
|
+
}
|
|
35428
|
+
}
|
|
35429
|
+
},
|
|
35430
|
+
"description": "Admin role required"
|
|
35431
|
+
},
|
|
35432
|
+
"404": {
|
|
35433
|
+
"content": {
|
|
35434
|
+
"application/json": {
|
|
35435
|
+
"schema": {
|
|
35436
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35437
|
+
}
|
|
35438
|
+
}
|
|
35439
|
+
},
|
|
35440
|
+
"description": "No individual with that NMLS id"
|
|
35441
|
+
}
|
|
35442
|
+
},
|
|
35443
|
+
"summary": "An LO's sponsorship / registration links (admin)",
|
|
35444
|
+
"tags": [
|
|
35445
|
+
"Admin: NMLS"
|
|
35446
|
+
]
|
|
35447
|
+
}
|
|
35448
|
+
},
|
|
35449
|
+
"/v1/admin/cad/load": {
|
|
35450
|
+
"post": {
|
|
35451
|
+
"description": "Starts the `load-cad` ECS task and returns its id. Poll `GET /v1/admin/cad/load/{taskId}`. The load writes the licensing database only; run `index-cad` afterwards (or pass `reindex: true`) to publish it.",
|
|
35452
|
+
"operationId": "adminLaunchCadLoad",
|
|
35453
|
+
"requestBody": {
|
|
35454
|
+
"content": {
|
|
35455
|
+
"application/json": {
|
|
35456
|
+
"schema": {
|
|
35457
|
+
"$ref": "#/components/schemas/AdminCadLoadRequest"
|
|
35458
|
+
}
|
|
35459
|
+
}
|
|
35460
|
+
},
|
|
35461
|
+
"required": true
|
|
35462
|
+
},
|
|
35463
|
+
"responses": {
|
|
35464
|
+
"202": {
|
|
35465
|
+
"content": {
|
|
35466
|
+
"application/json": {
|
|
35467
|
+
"schema": {
|
|
35468
|
+
"$ref": "#/components/schemas/AdminCadLoadLaunch"
|
|
35469
|
+
}
|
|
35470
|
+
}
|
|
35471
|
+
},
|
|
35472
|
+
"description": "Task launched"
|
|
35473
|
+
},
|
|
35474
|
+
"400": {
|
|
35475
|
+
"content": {
|
|
35476
|
+
"application/json": {
|
|
35477
|
+
"schema": {
|
|
35478
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35479
|
+
}
|
|
35480
|
+
}
|
|
35481
|
+
},
|
|
35482
|
+
"description": "Invalid body"
|
|
35483
|
+
},
|
|
35484
|
+
"401": {
|
|
35485
|
+
"content": {
|
|
35486
|
+
"application/json": {
|
|
35487
|
+
"schema": {
|
|
35488
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35489
|
+
}
|
|
35490
|
+
}
|
|
35491
|
+
},
|
|
35492
|
+
"description": "Not authenticated"
|
|
35493
|
+
},
|
|
35494
|
+
"403": {
|
|
35495
|
+
"content": {
|
|
35496
|
+
"application/json": {
|
|
35497
|
+
"schema": {
|
|
35498
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35499
|
+
}
|
|
35500
|
+
}
|
|
35501
|
+
},
|
|
35502
|
+
"description": "Admin role required"
|
|
35503
|
+
},
|
|
35504
|
+
"503": {
|
|
35505
|
+
"content": {
|
|
35506
|
+
"application/json": {
|
|
35507
|
+
"schema": {
|
|
35508
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35509
|
+
}
|
|
35510
|
+
}
|
|
35511
|
+
},
|
|
35512
|
+
"description": "ECS not configured (local dev)"
|
|
35513
|
+
}
|
|
35514
|
+
},
|
|
35515
|
+
"summary": "Launch the NMLS loader (admin)",
|
|
35516
|
+
"tags": [
|
|
35517
|
+
"Admin: NMLS"
|
|
35518
|
+
]
|
|
35519
|
+
}
|
|
35520
|
+
},
|
|
35521
|
+
"/v1/admin/cad/load/{taskId}": {
|
|
35522
|
+
"get": {
|
|
35523
|
+
"description": "ECS lifecycle of a `load-cad` task. `succeeded` = exited 0 (load completed or paused); `failed` = any other stop. Per-file progress is in the task logs and the load bookkeeping tables.",
|
|
35524
|
+
"operationId": "adminGetCadLoadTask",
|
|
35525
|
+
"parameters": [
|
|
35526
|
+
{
|
|
35527
|
+
"description": "ECS task id returned by the launch route.",
|
|
35528
|
+
"in": "path",
|
|
35529
|
+
"name": "taskId",
|
|
35530
|
+
"required": true,
|
|
35531
|
+
"schema": {
|
|
35532
|
+
"description": "ECS task id returned by the launch route.",
|
|
35533
|
+
"example": "0123456789abcdef0123456789abcdef",
|
|
35534
|
+
"pattern": "^[a-f0-9]{32}$/u",
|
|
35535
|
+
"type": "string"
|
|
35536
|
+
}
|
|
35537
|
+
}
|
|
35538
|
+
],
|
|
35539
|
+
"responses": {
|
|
35540
|
+
"200": {
|
|
35541
|
+
"content": {
|
|
35542
|
+
"application/json": {
|
|
35543
|
+
"schema": {
|
|
35544
|
+
"$ref": "#/components/schemas/AdminCadLoadTaskStatus"
|
|
35545
|
+
}
|
|
35546
|
+
}
|
|
35547
|
+
},
|
|
35548
|
+
"description": "Task status"
|
|
35549
|
+
},
|
|
35550
|
+
"401": {
|
|
35551
|
+
"content": {
|
|
35552
|
+
"application/json": {
|
|
35553
|
+
"schema": {
|
|
35554
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35555
|
+
}
|
|
35556
|
+
}
|
|
35557
|
+
},
|
|
35558
|
+
"description": "Not authenticated"
|
|
35559
|
+
},
|
|
35560
|
+
"403": {
|
|
35561
|
+
"content": {
|
|
35562
|
+
"application/json": {
|
|
35563
|
+
"schema": {
|
|
35564
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35565
|
+
}
|
|
35566
|
+
}
|
|
35567
|
+
},
|
|
35568
|
+
"description": "Admin role required"
|
|
35569
|
+
},
|
|
35570
|
+
"404": {
|
|
35571
|
+
"content": {
|
|
35572
|
+
"application/json": {
|
|
35573
|
+
"schema": {
|
|
35574
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
35575
|
+
}
|
|
35576
|
+
}
|
|
35577
|
+
},
|
|
35578
|
+
"description": "No load-cad task with that id (or ECS expired it)"
|
|
35579
|
+
}
|
|
35580
|
+
},
|
|
35581
|
+
"summary": "Status of a loader task (admin)",
|
|
35582
|
+
"tags": [
|
|
35583
|
+
"Admin: NMLS"
|
|
35584
|
+
]
|
|
35585
|
+
}
|
|
35586
|
+
},
|
|
34962
35587
|
"/v1/admin/jobs/{jobId}": {
|
|
34963
35588
|
"get": {
|
|
34964
35589
|
"description": "Returns any org's bulk job (delivery or enrichment) with a freshly signed download URL for its result file. Cross-org: signs against the job's own stored org. `resultsUrl` is null until the job is completed.",
|
|
@@ -58843,7 +59468,7 @@
|
|
|
58843
59468
|
}
|
|
58844
59469
|
}
|
|
58845
59470
|
},
|
|
58846
|
-
"description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
|
|
59471
|
+
"description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value. Also returned with `code: \"TIME_AT_COMPANY_SCOPE\"` when `timeAtCompanyMonths` is set, the other filters match more than 200,000 originators, and the requested page lies past the tenure matches found among the first 200,000 — narrow the request."
|
|
58847
59472
|
},
|
|
58848
59473
|
"401": {
|
|
58849
59474
|
"content": {
|